Skip to content

Add WebSocket connection domain - #115

Open
gryphon2411 wants to merge 2 commits into
sphinx-contrib:mainfrom
gryphon2411:feature/websocket-connection-domain
Open

Add WebSocket connection domain#115
gryphon2411 wants to merge 2 commits into
sphinx-contrib:mainfrom
gryphon2411:feature/websocket-connection-domain

Conversation

@gryphon2411

@gryphon2411 gryphon2411 commented Aug 2, 2026

Copy link
Copy Markdown

Summary

  • add an isolated websocket Sphinx domain with connection directives, roles, routing table, directional message fields, and stable anchors
  • document the MVP and add package-local French and Spanish catalogs
  • preserve HTTP behavior while sharing typed-path rendering, and add Sphinx 6.2 compatibility coverage

Verification

  • tox r
  • independent senior-engineer review; all findings were fixed and rechecked

Closes #25

@gryphon2411

Copy link
Copy Markdown
Author

@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.

@read-the-docs-community

read-the-docs-community Bot commented Aug 2, 2026

Copy link
Copy Markdown

Documentation build overview

📚 sphinxcontrib-httpdomain | 🛠️ Build #34101388 | 📁 Comparing 3fcdc46 against latest (1d96b0f)

  🔍 Preview build  

2 files changed
+ websocket-routingtable.html
± index.html

@gryphon2411
gryphon2411 force-pushed the feature/websocket-connection-domain branch from 59073bf to 5b2f47e Compare August 2, 2026 12:12
@stevepiercy

Copy link
Copy Markdown
Collaborator

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 main. Please stand by.

@stevepiercy stevepiercy reopened this Aug 11, 2026
@stevepiercy

Copy link
Copy Markdown
Collaborator

@gryphon2411 Can you update your branch to main? I made a recent fix for the py314 environment for documentation links, but the usual button that allows me to update the branch on PRs doesn't show up, even though I'm an Admin on this repo. Then I can do a proper review. Thank you!

@gryphon2411
gryphon2411 force-pushed the feature/websocket-connection-domain branch from 5b2f47e to fbb99f1 Compare August 11, 2026 06:18
@gryphon2411

Copy link
Copy Markdown
Author

@stevepiercy The branch is now rebased onto current main (738392e), and tox r passes locally. It should be ready for your review.

@stevepiercy

Copy link
Copy Markdown
Collaborator

@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 stevepiercy left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Comment thread test/websocket_test.py Outdated
Comment thread docs/index.rst Outdated
Comment thread CHANGELOG.rst Outdated
Comment thread docs/index.rst Outdated
Comment thread docs/index.rst Outdated
Comment thread docs/index.rst Outdated
Comment thread docs/index.rst Outdated
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.
@gryphon2411
gryphon2411 force-pushed the feature/websocket-connection-domain branch from fbb99f1 to 3fcdc46 Compare August 17, 2026 11:57
@gryphon2411

Copy link
Copy Markdown
Author

@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
stevepiercy enabled auto-merge (squash) August 18, 2026 10:59
@stevepiercy
stevepiercy disabled auto-merge August 18, 2026 11:00

@stevepiercy stevepiercy left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

@stevepiercy

Copy link
Copy Markdown
Collaborator

@gryphon2411 I think your base branch is protected, and therefore I can't easily update your branch against main. Would you please do so? Then I can run CI checks and merge. Please let me know. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add WebSocket resource endpoint

2 participants