enum-tools 0.2.0

Alternative method for documenting enums with Sphinx.

Alternative method for documenting enums with Sphinx.

Docs
Tests
PyPI
Anaconda
Activity
Other

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

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

1. https://docs.python.org/3/library/enum.html

2. Is it possible to define a class constant inside an Enum?

3. Enums with Attributes

4. When should I subclass EnumMeta instead of Enum?