On Jan 22, 7:17 pm, Georg Brandl <[email protected]> wrote:
> Instead, use :class:`~handlers.FileHandler` or somesuch -- the tilde
> will remove everything before the last name part from the output
> while pointing to the right class.
This is a good suggestion, thanks very much. Sorry I missed this - the
Python docs (e.g. http://docs.python.org/documenting/markup.html#inline-markup)
are (understandably) less up to date than the Sphinx ones (e.g.
http://sphinx.pocoo.org/markup/inline.html?highlight=class%20reference).
I had another thought about class references. If I use
a :class:`MyClass` reference, this links to the .. class:: MyClass
target, which by convention is used for the class constructor.
However, it's often desirable for it to link to some sort of overview
section which describes the class, before leading on to sections
describing the constructor and other methods. For example, in
logging.rst, for each handler, I have a brief para describing the
handler before the constructor is documented. Is there room for a
(new) role such as e.g. :class-overview: for such a purpose, or is
there a better way (than use of :ref:) of achieving links to class
overview sections?
Vinay
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~----------~----~----~----~------~----~------~--~---
