diff options
| author | Georg Brandl <georg@python.org> | 2010-02-28 11:39:13 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-02-28 11:39:13 +0100 |
| commit | ffe393b1b0a47d28c770668378ccff750fa82be3 (patch) | |
| tree | 7338193901f847626069f9805128bb24f24bf01f /doc/ext/autodoc.rst | |
| parent | 887ee5f5291ccf51bdddf137a4cd8df20b3482a5 (diff) | |
| download | sphinx-ffe393b1b0a47d28c770668378ccff750fa82be3.tar.gz | |
#187: Added support for source ordering of members in autodoc, with ``autodoc_member_order = 'bysource'``.
Diffstat (limited to 'doc/ext/autodoc.rst')
| -rw-r--r-- | doc/ext/autodoc.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index 4098d711..08a54082 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -223,10 +223,16 @@ There are also new config values that you can set: .. confval:: autodoc_member_order This value selects if automatically documented members are sorted - alphabetical (value ``'alphabetical'``) or by member type (value - ``'groupwise'``). The default is alphabetical. + alphabetical (value ``'alphabetical'``), by member type (value + ``'groupwise'``) or by source order (value ``'bysource'``). The default is + alphabetical. + + Note that for source order, the module must be a Python module with the + source code available. .. versionadded:: 0.6 + .. versionchanged:: 1.0 + Support for ``'bysource'``. .. confval:: autodoc_default_flags |