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

More doc.

Browse Source
This commit is contained in:
Georg Brandl 2010-03-01 11:13:33 +01:00
parent 9ebf346c18
commit 11bac45b10
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sphinx/directives/__init__.py
View File

@ -67,12 +67,18 @@ class ObjectDescription(Directive):
Parse the signature *sig* into individual nodes and append them to Parse the signature *sig* into individual nodes and append them to
*signode*. If ValueError is raised, parsing is aborted and the whole *signode*. If ValueError is raised, parsing is aborted and the whole
*sig* is put into a single desc_name node. *sig* is put into a single desc_name node.
The return value should be a value that identifies the object. It is
passed to :meth:`add_target_and_index()` unchanged, and otherwise only
used to skip duplicates.
""" """
raise ValueError raise ValueError
def add_target_and_index(self, name, sig, signode): def add_target_and_index(self, name, sig, signode):
""" """
Add cross-reference IDs and entries to self.indexnode, if applicable. Add cross-reference IDs and entries to self.indexnode, if applicable.
*name* is whatever :meth:`handle_signature()` returned.
""" """
return # do nothing by default return # do nothing by default