Skip to main content

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-trio-1.1.2.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_trio-1.1.2-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file sphinxcontrib-trio-1.1.2.tar.gz.

File metadata

  • Download URL: sphinxcontrib-trio-1.1.2.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for sphinxcontrib-trio-1.1.2.tar.gz
Algorithm Hash digest
SHA256 9f1ba9c1d5965b534e85258d8b677dd94e9b1a9a2e918b85ccd42590596b47c0
MD5 55d12f8888ee0207c41ffc90cfe51e87
BLAKE2b-256 ca33ee48d86e30bb3c5d72a47f49b1ebf5c23dd253b04d8d5fc3e6c68407a03e

See more details on using hashes here.

Provenance

File details

Details for the file sphinxcontrib_trio-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: sphinxcontrib_trio-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for sphinxcontrib_trio-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1b849be08a147ef4113e35c191a51c5792613a9a54697b497cd91656d906a232
MD5 6dc478155143dce8106c4f608081a0dd
BLAKE2b-256 a74d6e1598531046c272730501337d5303ce3958387a4fde1da8875580f5c41b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page