Merge pull request #5120 from blueyed/fix-doc

doc: fix list with add_object_type
This commit is contained in:
Takeshi KOMIYA 2018-06-26 00:40:22 +09:00 committed by GitHub
commit 1a477397b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -850,8 +850,9 @@ class Sphinx(object):
object. It will automatically add index entries if *indextemplate* object. It will automatically add index entries if *indextemplate*
is nonempty; if given, it must contain exactly one instance of is nonempty; if given, it must contain exactly one instance of
``%s``. See the example below for how the template will be ``%s``. See the example below for how the template will be
interpreted. * Create a new role (called *rolename*) to interpreted.
cross-reference to these object descriptions. - Create a new role (called *rolename*) to cross-reference to these
object descriptions.
- If you provide *parse_node*, it must be a function that takes a - If you provide *parse_node*, it must be a function that takes a
string and a docutils node, and it must populate the node with string and a docutils node, and it must populate the node with
children parsed from the string. It must then return the name of the children parsed from the string. It must then return the name of the