Skip to main content

Alternative method for documenting enums with Sphinx.

Docs

Documentation 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

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?

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.1.1.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

enum_tools-0.1.1-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file enum_tools-0.1.1.tar.gz.

File metadata

  • Download URL: enum_tools-0.1.1.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.7

File hashes

Hashes for enum_tools-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3b2675e0dea6eba8be75c8f66db9bd0c3fb1915b956f2302ba09285816e8afe2
MD5 9eb3658fdb782ce812dab91adf15b943
BLAKE2b-256 bc08192ee7560660a8f797183b39852bf969abffc0711ad18889fb5885031172

See more details on using hashes here.

File details

Details for the file enum_tools-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: enum_tools-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.7

File hashes

Hashes for enum_tools-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e4d77a13b81eeef207f64653aa2003a5c43ab40dfb2a7de87cbe82273271f183
MD5 112b60b70ad12bc5d42d6513f4edb508
BLAKE2b-256 971bfb15a47ace1b301553edaf17ba5c3d5ea22837f6c948f1ffe5cac436aef1

See more details on using hashes here.

Release history Release notifications | RSS feed

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0.post1

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.3

2 files

0.1.2

2 files

This release

0.1.1 This release

2 files

0.0.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page