Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
finam
Manage
Activity
Members
Labels
Plan
Issues
32
Issue boards
Milestones
Code
Merge requests
3
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
FINAM
finam
Commits
ef159765
Commit
ef159765
authored
5 months ago
by
Sebastian Müller
🐈
Browse files
Options
Downloads
Patches
Plain Diff
Docs: better docs for Enums
parent
98d2a5e2
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!286
Add mask to Info object
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/source/_templates/autosummary/class.rst
+1
-1
1 addition, 1 deletion
docs/source/_templates/autosummary/class.rst
docs/source/conf.py
+15
-0
15 additions, 0 deletions
docs/source/conf.py
with
16 additions
and
1 deletion
docs/source/_templates/autosummary/class.rst
+
1
−
1
View file @
ef159765
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
docs/source/conf.py
+
15
−
0
View file @
ef159765
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:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment