Document new :py:func:.blah syntax.

This commit is contained in:
Georg Brandl 2010-06-12 11:37:56 +02:00
parent 09e6001e7a
commit c891fdfc60
2 changed files with 7 additions and 3 deletions

View File

@ -363,6 +363,13 @@ dot, this order is reversed. For example, in the documentation of Python's
:mod:`codecs` module, ``:py:func:`open``` always refers to the built-in
function, while ``:py:func:`.open``` refers to :func:`codecs.open`.
Also, if the name is prefixed with a dot, and no exact match is found, the
target is taken as a suffix and all object names with that suffix are
searched. For example, ``:py:meth:`.TarFile.close``` references the
``tarfile.TarFile.close()`` function, even if the current module is not
``tarfile``. Since this can get ambiguous, if there is more than one possible
match, you will get a warning from Sphinx.
A similar heuristic is used to determine whether the name is an attribute of the
currently documented class.

View File

@ -16,9 +16,6 @@ Though there is support for that kind of docs as well (which is intended to be
freely mixed with hand-written content), if you need pure API docs have a look
at `Epydoc <http://epydoc.sf.net/>`_, which also understands reST.
.. function:: Sphinxy.add_domain()
:func:`.add_domain`
Conversion from other systems
-----------------------------