Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello! I have made some minor document corrections.
Summary
Add
wsproto.Connection
referencewsproto.Connection
is described in Post handshake connection, but it is not listed in the API reference in the documentation. It would be useful to see this in the documentation. Added autodoc directives toapi.rst
and fixed docstrings.Fix Read the Docs build
While working on the above fix, I noticed that the latest build of Read the Docs for wsproto is failing.
https://readthedocs.org/projects/wsproto/builds/22942691/
It looks like the
.readthedocs.yaml
file is now required to build Read the Docs 1. The.readthedocs.yaml
file has been added. Also addedrequirements.txt
for the documentation, since thesphinx-rtd-theme
is not automatically applied.I don't think the Read the docs preview in the pull request is set up, so I built the docs in the fork repository. You can check that here
https://improved-octo-garbanzo.readthedocs.io/en/latest/api.html#wsproto.Connection
Footnotes
https://blog.readthedocs.com/migrate-configuration-v2/ ↩