Enum Tools

Alternative method for documenting enums with Sphinx.

Docs

Documentation Build Status Docs Check Status

Tests

Travis Build Status Windows Tests Status macOS Tests Status Coverage CodeFactor Grade

PyPI

PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel

Anaconda

Conda - Package Version Conda - Platform

Activity

GitHub last commit GitHub commits since tagged version Maintenance

Other

License GitHub top language Requirements Status pre-commit

This package has two features:

  1. A decorator to add docstrings to Enum members from a comment at the end of the line.

  2. A Sphinx extension to document Enums better than autoclass can currently.

Installation

python3 -m pip install enum_tools --user

First add the required channels

conda config --add channels https://conda.anaconda.org/domdfcoding
conda config --add channels https://conda.anaconda.org/conda-forge

Then install

conda install enum_tools
python3 -m pip install git+https://github.com/domdfcoding/enum_tools@master --user

View the Function Index or browse the Source Code.

Browse the GitHub Repository