Skip to content

Commit

Permalink
Update README.rst to match index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
domdfcoding committed Jan 3, 2022
1 parent fdee93f commit 4fd82e7
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,14 @@ Enum Tools

.. end shields
|
This package has two features:
This library provides the following:

#. 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.
#. ``enum_tools.autoenum`` -- A `Sphinx <https://www.sphinx-doc.org>`_ extension to document Enums better than ``autoclass``
can currently.
#. ``@enum_tools.documentation.document_enum`` -- A decorator to add docstrings to ``Enum`` members
from a comment at the end of the line.
#. ``enum_tools.custom_enums`` -- Additional ``Enum`` classes with different functionality.


Installation
Expand Down

0 comments on commit 4fd82e7

Please sign in to comment.