Skip to content

Commit

Permalink
Change docs version and autodoc options.
Browse files Browse the repository at this point in the history
  • Loading branch information
ynikitenko committed May 9, 2020
1 parent 50e9f84 commit df607df
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
19 changes: 10 additions & 9 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ def setup(app):
author = u'Yaroslav Nikitenko'

# The short X.Y version
version = u'0.1'
version = u'0.2'
# The full version, including alpha/beta/rc tags
release = u'0.1'
release = u'0.2'
# release = u'0.1-alpha'


Expand Down Expand Up @@ -62,15 +62,16 @@ def setup(app):

# automodapi seems nice, but I could't get it generate separate class pages
# automodapi_inheritance_diagram = False
autodoc_default_flags = ['members']

# autodoc_default_flags = ['members']
# unfortunately, this gives a warning when __call__ is missing
# https://github.com/sphinx-doc/sphinx/issues/6771
# autodoc_default_options = {
# 'members': True,
# 'special-members': '__call__',
# # 'undoc-members': True,
# # 'exclude-members': '__weakref__'
# }
autodoc_default_options = {
'members': True,
'special-members': '__call__',
# 'undoc-members': True,
# 'exclude-members': '__weakref__'
}
autosummary_generate = True

# Both the class' and the __init__ method's docstring are concatenated and inserted.
Expand Down
1 change: 1 addition & 0 deletions docs/source/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Sequences
.. automodule:: lena.core
:no-members:
:no-special-members:

.. _Sequence:
.. autoclass:: Sequence
Expand Down
3 changes: 1 addition & 2 deletions docs/source/flow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ Group plots
-----------
.. automodule:: lena.flow.group_plots
:no-members:
:no-special-members:

.. currentmodule:: lena.flow
.. autoclass:: GroupBy
Expand All @@ -91,9 +92,7 @@ Group plots

.. autoclass:: Not
:show-inheritance:
:special-members: __call__
.. autoclass:: Selector
:special-members: __call__

Iterators
---------
Expand Down

0 comments on commit df607df

Please sign in to comment.