Skip to main content

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

Project description

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.

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

sphinx_autodoc_variants-0.1.0.tar.gz (4.4 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page