Skip to content
Snippets Groups Projects
Commit ef159765 authored by Sebastian Müller's avatar Sebastian Müller 🐈
Browse files

Docs: better docs for Enums

parent 98d2a5e2
No related branches found
No related tags found
1 merge request!286Add mask to Info object
......@@ -7,7 +7,7 @@
:private-members: _initialize, _connect, _validate, _update, _finalize, _get_data, _get_info, _source_updated, _pulled
:special-members: __getitem__
:undoc-members:
:inherited-members:
:inherited-members: object, int
:show-inheritance:
.. raw:: latex
......
import datetime
import inspect
from enum import Enum
from finam import __version__ as finam_version
def skip_member(app, what, name, obj, skip, options):
# Check if we're dealing with an Enum
if inspect.isclass(obj) and issubclass(obj, Enum):
if name not in [e.name for e in obj]:
return True # Skip anything that isn’t an enum member
return skip
def setup(app):
app.connect("autodoc-skip-member", skip_member)
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment