Add WebSocket connection domain - #115
Conversation
|
@stevepiercy, this implements the small separate WebSocket-domain MVP discussed in #25. It passes the full tox r suite; I would appreciate your review when you have time. |
Documentation build overview
|
59073bf to
5b2f47e
Compare
|
I'm going to close then reopen this PR to see if that will trigger a test build and allow me to update the branch with |
|
@gryphon2411 Can you update your branch to |
5b2f47e to
fbb99f1
Compare
|
@stevepiercy The branch is now rebased onto current main (738392e), and tox r passes locally. It should be ready for your review. |
|
@loelkes and @ilan-theodoro, since you liked this feature request, and I lack familiarity with WebSocket, I'd greatly appreciate your review on this PR. If there is anyone else who wants this feature, please feel free to review and provide feedback. This is a community effort. |
stevepiercy
left a comment
There was a problem hiding this comment.
This is excellent work, and thank you for cleaning up my omission in the change log. I have a few suggestions for you to consider. Would you please take care?
I feel confident that everything in this PR is solid, including the translations and moving the locale directory, documentation, and project meta information. Because I'm not familiar with WebSocket usage and its testing, I'd like to get another review from someone who has that familiarity. Do you have a colleague who can pitch in? Please let me know. Thank you!
Add the websocket:connection directive, cross-reference role, routing table, directional message fields, stable anchors, and native no-index handling. Extract shared typed-path rendering while preserving HTTP output. Move the message catalog into the extension package and add WebSocket translations. Document the WebSocket MVP and add Sphinx integration, inventory, locale, wheel-content, and Sphinx 6.2 compatibility coverage. Tests: tox r
Clarify the HTTP and WebSocket documentation structure, credit the contribution in the changelog, and align the test fixture with the project documentation theme.
fbb99f1 to
3fcdc46
Compare
|
@stevepiercy I have applied all of your inline suggestions and rebased the branch onto current main. The full tox r suite passes locally. I do not have an additional human reviewer to nominate, but I appreciate your invitations to @loelkes and @ilan-theodoro. I will gladly address any WebSocket-specific feedback they provide. |
stevepiercy
left a comment
There was a problem hiding this comment.
@gryphon2411 thank you for this long-awaited feature, and establishing a base for future improvements to WebSockets API documentation. I appreciate your patience and effort to improve sphinxcontrib-httpdomain.
If @loelkes or @ilan-theodoro would like to add on or offer feedback, they're welcome to do so anytime.
I'll merge after CI checks pass.
|
@gryphon2411 I think your base branch is protected, and therefore I can't easily update your branch against |
Summary
Verification
Closes #25