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

#564: Add :confval:autodoc_docstring_signature which retrieves the signature from the first line of the docstring, if it is found there.

Browse Source
This commit is contained in:
Georg Brandl
2011-01-03 22:51:33 +01:00
parent 594c1a90f4
commit f6cb763ff8
4 changed files with 84 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/ext/autodoc.rst
View File

@@ -285,6 +285,19 @@ There are also new config values that you can set:
.. versionadded:: 1.0
.. confval:: autodoc_docstring_signature
Functions imported from C modules cannot be introspected, and therefore the
signature for such functions cannot be automatically determined. However, it
is a well- convention
If this boolean value is set to ``True`` (which is the default), autodoc will
look at the first line of the docstring for functions and methods, and if it
looks like a signature, use the line as the signature and remove it from the
docstring content.
.. versionadded:: 1.1
Docstring preprocessing
-----------------------