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.5.0.tar.gz
(16.7 kB
view hashes)
Built Distribution
enum_tools-0.5.0-py3-none-any.whl
(17.5 kB
view hashes)
Close
Hashes for enum_tools-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a07030c53af70c15ee53eca550935130f22626de32e7a8b5566fbba37083ab35 |
|
MD5 | e094387c81f19dcb122effa8cf2a4680 |
|
BLAKE2b-256 | 435eae4a44bda395409f1e5b01ef0c1f6fe7b0eb47310db10ac1fb5684ab4c72 |