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.
Metadata
Release files for sphinxcontrib-trio 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinxcontrib_trio-1.2.0.tar.gz | 25.5 kB | Without provenance | Details for sphinxcontrib_trio-1.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinxcontrib_trio-1.2.0-py3-none-any.whl | Python 3 | none | any | Details for sphinxcontrib_trio-1.2.0-py3-none-any.whl |
Total release size: 37.6 kB
Release files / sphinxcontrib_trio-1.2.0.tar.gz
| Download URL | sphinxcontrib_trio-1.2.0.tar.gz |
|---|---|
| Size | 25.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c3b2866bbf10993d10168eaaf54329ce8828b71263ebb06d2f1f02bae67c0bcd
|
|
BLAKE2b-256 checksum How to use checksums |
c5bf1755b0e16c08d58a9224306f847ae1ba6ddd53d6b0628200f35d3ed21a4b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Release files / sphinxcontrib_trio-1.2.0-py3-none-any.whl
| Download URL | sphinxcontrib_trio-1.2.0-py3-none-any.whl |
|---|---|
| Size | 12.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
46d69e06c5145f814ce43a8946212547bf6ba8605319dd422c393d63f6ad39f7
|
|
BLAKE2b-256 checksum How to use checksums |
9ac72c36a1e4e41fe2359097486e7bbb3d96ac72873955777c9ba29bb26f96a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Security for sphinxcontrib-trio 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
