[docs] [issue9264] trace.py documentation is incomplete

Éric Araujo report at bugs.python.org
Sat Nov 27 13:38:02 CET 2010


Éric Araujo <merwok at netwok.org> added the comment:

I noticed too that the second form given in a cmdoption directive cannot be linked to from an option construct.  The workaround looks like this: :option:`--long <-l>`.  This uses a generic Sphinx (or reST) property: When using :role:`text <thing>`, “thing” will be given as argument to the role but “text” will be displayed.  It’s very useful for references for example, if you don’t want title case in the middle of your sentence of if you need to rephrase the title: “Have a look at the :ref:`detailed explanation <config-explanation>`”.

Even if it can be worked around, can you report this Sphinx bug?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9264>
_______________________________________


More information about the docs mailing list