search

python-hyper / wsproto

Sans-IO WebSocket protocol implementation
https://wsproto.readthedocs.io/
MIT License
261 stars 38 forks source link

Add wsproto.Connection reference #188

Closed MtkN1 closed 6 months ago

MtkN1 commented 7 months ago

Hello! I have made some minor document corrections.

Summary

  1. Add wsproto.Connection reference wsproto.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 to api.rst and fixed docstrings.

  2. 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/

    Problem in your project's configuration. No default configuration file found at repository's root. See https://docs.readthedocs.io/en/stable/config-file/

    It looks like the .readthedocs.yaml file is now required to build Read the Docs ^1. The .readthedocs.yaml file has been added. Also added requirements.txt for the documentation, since the sphinx-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

MtkN1 commented 6 months ago

Hello, maintainers. Is it possible to get a review? It is not a high priority :)

Kriechi commented 6 months ago

LGTM, but some minor linting issues and an issue with sdist packaging of the new config file, please see the CI failure log.

MtkN1 commented 6 months ago

Oh, sorry. I thought the CI error was unrelated since it was also occurring in the base branch.

I have fixed this. I think the CI that is failing now is the same as the previous pull request (https://github.com/python-hyper/wsproto/pull/187#issuecomment-1862702609).