Alternative method for documenting enums with Sphinx.
Project description
Alternative method for documenting enums with Sphinx.
Docs |
|
---|---|
Tests |
|
PyPI |
|
Anaconda |
|
Activity |
|
Other |
This package has two features:
A decorator to add docstrings to Enum members from a comment at the end of the line.
A Sphinx extension to document Enums better than autoclass can currently.
Installation
enum_tools can be installed from PyPI or Anaconda.
To install with pip:
$ python -m pip install enum_tools
To install with conda:
First add the required channels
$ conda config --add channels http://conda.anaconda.org/domdfcoding $ conda config --add channels http://conda.anaconda.org/conda-forge
Then install
$ conda install enum_tools
Further Reading
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
enum_tools-0.3.0.tar.gz
(15.1 kB
view hashes)
Built Distribution
enum_tools-0.3.0-py3-none-any.whl
(16.8 kB
view hashes)
Close
Hashes for enum_tools-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5044f0cdd7e14dbe1051339564f817321a08e8b0ffbedd3b63434bc9e6940037 |
|
MD5 | ae1db68d9d1d04a18c34f9acecbd5dea |
|
BLAKE2b-256 | 4b125934eb5117b5d41c4f9aa5319f3ade300ba25e50ad5ba8cfe1d3346c5335 |