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 |
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
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!
| "extensions = ['sphinxcontrib.httpdomain']\n" | ||
| "master_doc = 'index'\n" | ||
| "project = 'WebSocket test project'\n" | ||
| "html_theme = 'alabaster'\n" |
There was a problem hiding this comment.
I think this should be consistent with the theme used in sphinxcontrib.httpdomain's docs/conf.py.
| "html_theme = 'alabaster'\n" | |
| "html_theme = 'sphinxdoc'\n" |
| @@ -27,7 +27,7 @@ | |||
| :alt: GitHub Sponsors | |||
|
|
|||
| This contrib extension, :mod:`sphinxcontrib.httpdomain`, provides a Sphinx | |||
There was a problem hiding this comment.
| This contrib extension, :mod:`sphinxcontrib.httpdomain`, provides a Sphinx | |
| This contrib extension, :mod:`sphinxcontrib.httpdomain`, provides Sphinx |
| ............. | ||
|
|
||
| - Added a ``websocket`` domain for documenting bidirectional WebSocket | ||
| connections. |
There was a problem hiding this comment.
Let's include all the pieces, link to the issue, and give you credit.
| connections. | |
| connections, including tests, usage documentation, project meta information, | |
| and translations. [:pull:`115` by @gryphon2411] |
There was a problem hiding this comment.
Also thank you for handling my oversight in the change log to add a release date and add an Unreleased section. I appreciate the care you put into your work.
| .. versionadded:: 1.8.0 | ||
|
|
||
|
|
||
| .. _websocket-connections: |
There was a problem hiding this comment.
Please move this excellent new section just before the Author and License section. I want all the HTTP sections grouped together. We'll also need to disambiguate some headings and targets.
| Options | ||
| ``````` |
There was a problem hiding this comment.
Let's create a target for future use, and disambiguate from HTTP options.
| Options | |
| ``````` | |
| .. _websocket-options: | |
| WebSocket options | |
| ````````````````` |
There was a problem hiding this comment.
TIL, in suggestions, there needs to be three more backticks than those in the underline for GitHub markdown to render them in the suggestion. The default three backticks is not adequate.
| Directives | ||
| ---------- |
There was a problem hiding this comment.
Add context.
| HTTP directives | |
| --------------- |
| Options | ||
| ``````` |
There was a problem hiding this comment.
Disambiguate from WebSocket options.
| .. _http-options: | |
| HTTP options | |
| ```````````` |
Summary
Verification
Closes #25