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

autodoc: document novalue option

Browse Source 
The update is listed for version 1.2.
This should be changed if the change is released later.
This commit is contained in:
Johannes Dewender 2013-01-22 17:58:47 +01:00
parent 6b9f35455d
commit 391f99d13a
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/ext/autodoc.rst
View File

@ -197,8 +197,14 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
automethod
autoattribute
These work exactly like :rst:dir:`autoclass` etc., but do not offer the
options used for automatic member documentation.
These work exactly like :rst:dir:`autoclass` etc.,
but do not offer the options used for automatic member documentation.
:rst:dir:`autodata` and :rst:dir:`autoattribute` support
the ``novalue`` option. No value will be parsed from the code::
.. autodata:: CD_DRIVE
:novalue:
For module data members and class attributes, documentation can either be put
into a comment with special formatting (using a ``#:`` to start the comment
@ -234,6 +240,9 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
.. versionchanged:: 1.1
Comment docs are now allowed on the same line after an assignment.
.. versionchanged:: 1.2
:rst:dir:`autodata` and :rst:dir:`autoattribute` have a ``novalue`` option
.. note::
If you document decorated functions or methods, keep in mind that autodoc