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

Make it clearer how autodoc special comments have to be formatted.

Browse Source
This commit is contained in:
Georg Brandl
2012-03-17 16:54:17 +01:00
parent 1949bb17e7
commit fe8ed35dfb
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/ext/autodoc.rst
View File

@@ -194,12 +194,13 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
automethod automethod
autoattribute autoattribute
These work exactly like :rst:dir:`autoclass` etc., but do not offer the options These work exactly like :rst:dir:`autoclass` etc., but do not offer the
used for automatic member documentation. options used for automatic member documentation.
For module data members and class attributes, documentation can either be put For module data members and class attributes, documentation can either be put
into a special-formatted comment, or in a docstring *after* the definition. into a comment with special formatting (using a ``#:`` to start the comment
Comments need to be either on a line of their own *before* the definition, or instead of just ``#``), or in a docstring *after* the definition. Comments
need to be either on a line of their own *before* the definition, or
immediately after the assignment *on the same line*. The latter form is immediately after the assignment *on the same line*. The latter form is
restricted to one line only. restricted to one line only.