Make Sphinx better at documenting Python functions and methods
Project description
This sphinx extension helps you document Python code that uses async/await, or abstract methods, or context managers, or generators, or … you get the idea. It works by making sphinx’s regular directives for documenting Python functions and methods smarter and more powerful. The name is because it was originally written for the Trio project, and I’m not very creative. But don’t be put off – there’s nothing Trio- or async-specific about this extension; any Python project can benefit. (Though projects using async/await probably benefit the most, since sphinx’s built-in tools are especially inadequate in this case.)
Vital statistics
Requirements: This extension currently assumes you’re using Python 3.5+ to build your docs. This could be relaxed if anyone wants to send a patch.
Documentation: https://sphinxcontrib-trio.readthedocs.io
Bug tracker and source code: https://github.com/python-trio/sphinxcontrib-trio
License: MIT or Apache 2, your choice.
Usage: pip install -U sphinxcontrib-trio in the same environment where you installed sphinx, and then add "sphinxcontrib_trio" to the list of extensions in your project’s conf.py. (Notice that "sphinxcontrib_trio" has an underscore in it, NOT a dot. This is because I don’t understand namespace packages, and I fear things that I don’t understand.)
Code of conduct: Contributors are requested to follow our code of conduct in all project spaces.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinxcontrib-trio-1.0.1.tar.gz.
File metadata
- Download URL: sphinxcontrib-trio-1.0.1.tar.gz
- Upload date:
- Size: 22.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d1c3300a19a873d880ed04034121d3b2b22d3ac5dbff299fefa73cfc5908c507 |
|
| MD5 | f7b3250cadb18a9eeb1eb5e320abf587 |
|
| BLAKE2b-256 | ced028733595ea799318219e71905d4e42e168d0db2d4714842623df824a2277 |
File details
Details for the file sphinxcontrib_trio-1.0.1-py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_trio-1.0.1-py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 763ff694220c9a3adfcd66598a8b6941f1e231edcdd4c1de58a4419fbf662ad8 |
|
| MD5 | 152b623bf41bc10b37d22668e52c58f8 |
|
| BLAKE2b-256 | 092870870892f814a46db677872ba8da59936601d00f1109dc9359b122d3a8fc |
