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

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 Enum``s better than ``autoclass can currently.

Installation

enum_tools can be installed from PyPI.

To install with pip:

$ python -m pip 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.0.2.tar.gz (13.8 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.0.2-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: enum_tools-0.0.2.tar.gz
  • Upload date:
  • Size: 13.8 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.0.2.tar.gz
Algorithm Hash digest
SHA256 9fd42e97e04cc210e78923a0d2a36538af1430b4d2362365f4a6fed466a3c243
MD5 a672fbcc7885c90ea0076385c877ec81
BLAKE2b-256 96b14ff74c292dca0503632b4e8d23fc8637b5b181d3629363cdccdac3ce5dff

See more details on using hashes here.

File details

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

File metadata

  • Download URL: enum_tools-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 15.1 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.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 54ad63add0ff52e5c8adda7ee0fe3f9213803919d8260ef2ae6c2a6818576a0d
MD5 8adb2f6271c7d45070ba627b6a7f5f3b
BLAKE2b-256 c7bf1e747a985999ac2a38e0047e8fdc223b2cab6d2f0a7f99dda095dede150e

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

0.1.1

2 files

This release

0.0.2 This release

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