IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5533 from ericvw/autodoc_member-only_default-options

Browse Source 
autodoc: Respect `member-order` in `autodoc_default_options` as documented
This commit is contained in:
Takeshi KOMIYA 2018-10-17 11:12:56 +09:00 committed by GitHub
commit 44b385e2c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 29 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
AUTHORS
View File

@ -68,6 +68,7 @@ Other contributors, listed alphabetically, are:
* Antonio Valentino -- qthelp builder, docstring inheritance * Antonio Valentino -- qthelp builder, docstring inheritance
* Filip Vavera -- napoleon todo directive * Filip Vavera -- napoleon todo directive
* Pauli Virtanen -- autodoc improvements, autosummary extension * Pauli Virtanen -- autodoc improvements, autosummary extension
* Eric N. Vander Weele -- autodoc improvements
* Stefan van der Walt -- autosummary extension * Stefan van der Walt -- autosummary extension
* Thomas Waldmann -- apidoc module fixes * Thomas Waldmann -- apidoc module fixes
* John Waltman -- Texinfo builder * John Waltman -- Texinfo builder

7
doc/usage/extensions/autodoc.rst
View File

@ -383,9 +383,10 @@ There are also new config values that you can set:
Setting ``None`` is equivalent to giving the option name in the list format Setting ``None`` is equivalent to giving the option name in the list format
(i.e. it means "yes/true/on"). (i.e. it means "yes/true/on").
The supported options are ``'members'``, ``'undoc-members'``, The supported options are ``'members'``, ``'member-order'``,
``'private-members'``, ``'special-members'``, ``'inherited-members'``, ``'undoc-members'``, ``'private-members'``, ``'special-members'``,
``'show-inheritance'``, ``'ignore-module-all'`` and ``'exclude-members'``. ``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and
``'exclude-members'``.
.. versionadded:: 1.8 .. versionadded:: 1.8

2
sphinx/ext/autodoc/directive.py
View File

@ -31,7 +31,7 @@ logger = logging.getLogger(__name__)
# common option names for autodoc directives # common option names for autodoc directives
AUTODOC_DEFAULT_OPTIONS = ['members', 'undoc-members', 'inherited-members', AUTODOC_DEFAULT_OPTIONS = ['members', 'undoc-members', 'inherited-members',
'show-inheritance', 'private-members', 'special-members', 'show-inheritance', 'private-members', 'special-members',
'ignore-module-all', 'exclude-members'] 'ignore-module-all', 'exclude-members', 'member-order']
class DummyOptionSpec: class DummyOptionSpec:

23
tests/test_autodoc.py
View File

@ -1569,6 +1569,29 @@ def test_autodoc_default_options_with_values(app):
assert ' .. py:attribute:: EnumCls.val3' not in actual assert ' .. py:attribute:: EnumCls.val3' not in actual
assert ' .. py:attribute:: EnumCls.val4' not in actual assert ' .. py:attribute:: EnumCls.val4' not in actual
# with :member-order:
app.config.autodoc_default_options = {
'members': None,
'member-order': 'bysource',
}
actual = do_autodoc(app, 'class', 'target.Class')
assert list(filter(lambda l: '::' in l, actual)) == [
'.. py:class:: Class(arg)',
' .. py:attribute:: Class.descr',
' .. py:method:: Class.meth()',
' .. py:method:: Class.skipmeth()',
' .. py:method:: Class.excludemeth()',
' .. py:attribute:: Class.attr',
' .. py:attribute:: Class.prop',
' .. py:attribute:: Class.docattr',
' .. py:attribute:: Class.udocattr',
' .. py:attribute:: Class.mdocattr',
' .. py:classmethod:: Class.moore(a, e, f) -> happiness',
' .. py:attribute:: Class.inst_attr_inline',
' .. py:attribute:: Class.inst_attr_comment',
' .. py:attribute:: Class.inst_attr_string',
]
# with :special-members: # with :special-members:
app.config.autodoc_default_options = { app.config.autodoc_default_options = {
'special-members': '__init__,__iter__', 'special-members': '__init__,__iter__',