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

Remove docs for removed automodule_skip_lines setting.

Browse Source
This commit is contained in:
Georg Brandl
2009-02-27 15:22:45 +01:00
parent e5c8f5caff
commit dd32405563
1 changed files with 0 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/ext/autodoc.rst
View File

@@ -182,19 +182,6 @@ directive.
There are also new config values that you can set: There are also new config values that you can set:
.. confval:: automodule_skip_lines
This value (whose default is ``0``) can be used to skip an amount of lines in
every module docstring that is processed by an :dir:`automodule` directive.
This is provided because some projects like to put headings in the module
docstring, which would then interfere with your sectioning, or automatic
fields with version control tags, that you don't want to put in the generated
documentation.
.. deprecated:: 0.4
Use the more versatile docstring processing provided by
:event:`autodoc-process-docstring`.
.. confval:: autoclass_content .. confval:: autoclass_content
This value selects what content will be inserted into the main body of an This value selects what content will be inserted into the main body of an