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

doc: Use AutodocReporter at example of nested_parse_with_titles()

Browse Source 
In detail, please refer following thread:
https://groups.google.com/forum/#!topic/sphinx-dev/l4fHrIJfwq4
This commit is contained in:
Takeshi KOMIYA 2016-09-07 15:45:38 +09:00
parent 5a02c6162b
commit 3eb56b1c6f
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/extdev/markupapi.rst
View File

@ -125,6 +125,8 @@ Both APIs parse the content into a given node. They are used like this::
node = docutils.nodes.paragraph()
# either
from sphinx.ext.autodoc import AutodocReporter
self.state.memo.reporter = AutodocReporter(self.result, self.state.memo.reporter) # override reporter to avoid errors from "include" directive
nested_parse_with_titles(self.state, self.result, node)
# or
self.state.nested_parse(self.result, 0, node)