sphinx automodule doesn't document members by default anymore

This commit is contained in:
David Halter
2013-02-03 23:59:03 +01:00
parent f0108d494f
commit 0ce1bfda72
3 changed files with 7 additions and 11 deletions

View File

@@ -267,4 +267,5 @@ todo_include_todos = False
# -- Options for autodoc module ------------------------------------------------ # -- Options for autodoc module ------------------------------------------------
autodoc_member_order = 'bysource' autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members'] autodoc_default_flags = []
#autodoc_default_flags = ['members', 'undoc-members']

View File

@@ -40,7 +40,6 @@ Parser (parsing.py)
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
.. automodule:: parsing .. automodule:: parsing
:no-members:
.. _dev-evaluate: .. _dev-evaluate:
@@ -48,7 +47,6 @@ Evaluation of python code (evaluate.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: evaluate .. automodule:: evaluate
:no-members:
@@ -59,19 +57,16 @@ Modules (modules.py)
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. automodule:: module .. automodule:: module
:no-members:
Builtin Modules (builtin.py) Builtin Modules (builtin.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: builtin .. automodule:: builtin
:no-members:
Imports (imports.py) Imports (imports.py)
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. automodule:: imports .. automodule:: imports
:no-members:
@@ -82,7 +77,6 @@ Caching (cache.py)
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
.. automodule:: cache .. automodule:: cache
:no-members:
Recursions (recursion.py) Recursions (recursion.py)
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -99,19 +93,16 @@ Docstrings (docstrings.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: docstrings .. automodule:: docstrings
:no-members:
Dynamic Arrays & Function Parameters (dynamic.py) Dynamic Arrays & Function Parameters (dynamic.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: dynamic .. automodule:: dynamic
:no-members:
Refactoring (docstrings.py) Refactoring (docstrings.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: refactoring .. automodule:: refactoring
:no-members:
@@ -127,4 +118,3 @@ Python 2/3 compatibility (_compatibility.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: _compatibility .. automodule:: _compatibility
:no-members:

View File

@@ -19,12 +19,17 @@ API Interface
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
.. automodule:: api .. automodule:: api
:members:
:undoc-members:
API Return Classes API Return Classes
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
.. automodule:: api_classes .. automodule:: api_classes
:members:
:undoc-members:
Settings Module Settings Module
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~