Skip to main content

sphinx_autodoc_variants

https://travis-ci.org/python-variants/sphinx_autodoc_variants.svg?branch=master

An extension for sphinx to allow automatic documentation of variants functions.

Overview

The default sphinx.ext.autodoc module does not handle function groups with variants created by the variants module correctly. This extension registers an automatic documenter that detects variant functions and methods and enables documentation of both the primary and variant functions.

To use this with your project that uses variants, first install this extension with pip (or, preferably, add this to the documentation dependencies):

pip install sphinx_autodoc_variants

With this installed, add 'sphinx_autodoc_variants' to the extensions variable of your conf.py, e.g.:

extensions = ['sphinx.ext.autodoc',
              'sphinx.ext.viewcode',
              'sphinx_autodoc_variants']

This will enable proper documentation of variants functions under .. automodule or other autodoc directives.

If you want to explicitly document a variants function group, use .. autoprimary_function for functions and .. autoprimary_method for methods.

Metadata

Release files for sphinx-autodoc-variants 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-autodoc-variants 0.1.0
File Size Uploaded Provenance Actions
sphinx_autodoc_variants-0.1.0.tar.gz 4.4 kB Without provenance Details for sphinx_autodoc_variants-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-autodoc-variants 0.1.0
File Interpreter ABI Platform Actions
sphinx_autodoc_variants-0.1.0-py2.py3-none-any.whl Python 3, Python 2 none any Details for sphinx_autodoc_variants-0.1.0-py2.py3-none-any.whl

Total release size: 8.4 kB

Release files / sphinx_autodoc_variants-0.1.0.tar.gz

Download URL sphinx_autodoc_variants-0.1.0.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
cc156b4e7dce70cda5b2322dc53a0b37e54292a28e1ffe521e62869e908b089f
BLAKE2b-256 checksum
How to use checksums
1bd2925bda48553e3e8419b529d9c8dc8598ff2de6c1ae9296a317d43c056441
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / sphinx_autodoc_variants-0.1.0-py2.py3-none-any.whl

Download URL sphinx_autodoc_variants-0.1.0-py2.py3-none-any.whl
Size 4.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
ebe80d21bfd4fffd2474615f987b2774154edd244e1a56ca2e223b61173a02b3
BLAKE2b-256 checksum
How to use checksums
7ef9d2f11964ed49434e4f3971b819fd7cf11ad6a997620cf71328698b775147
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for sphinx-autodoc-variants 0.1.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.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page