diff options
| author | Eric N. Vander Weele <ericvw@gmail.com> | 2018-10-14 20:19:03 -0400 |
|---|---|---|
| committer | Eric N. Vander Weele <ericvw@gmail.com> | 2018-10-16 10:21:18 -0700 |
| commit | 9fcef5030accbb4430abe7c8ae4becba089d0f45 (patch) | |
| tree | 3ea97f5fc4ec5919ed840cbe3b5e034e9e37f17a /sphinx/ext/autodoc/directive.py | |
| parent | d6b9db9581fd12b15f085e9138e077d31186ee68 (diff) | |
| download | sphinx-git-9fcef5030accbb4430abe7c8ae4becba089d0f45.tar.gz | |
autodoc: Respect `member-order` in `autodoc_default_options` as documented
In the `autodoc_default_options` documentation, it mentions that
`member-order` is respected; however, when setting the key-value pair in
`conf.py`, it is not. Thus, add `member-order` as one of the default
options respected in `conf.py`. Additionally, update the list of
supported options to match the example.
Diffstat (limited to 'sphinx/ext/autodoc/directive.py')
| -rw-r--r-- | sphinx/ext/autodoc/directive.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index e831cab64..cf1f2f47f 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -31,7 +31,7 @@ logger = logging.getLogger(__name__) # common option names for autodoc directives AUTODOC_DEFAULT_OPTIONS = ['members', 'undoc-members', 'inherited-members', 'show-inheritance', 'private-members', 'special-members', - 'ignore-module-all', 'exclude-members'] + 'ignore-module-all', 'exclude-members', 'member-order'] class DummyOptionSpec: |