Hi all,

Consider the following usage situation:

Currently, to look up the built-in `reduce()` Python function
description in this document:

  http://docs.python.org/library/functions.html

users need to:

 * Use the Sphinx search functionality over the document set
 * Use their browser's search functionality on the page
 * Scroll the page down to find it.

In the Django documentation these two requirements, namely:

 * Having the object name marked with so it can be used in cross
   references, appears in the relevant module index, etc.
 * Getting it listed in the table of contents as described above

are achieved by having two versions of the function signature with the
relevant reST markup aplied to them:

http://code.djangoproject.com/browser/django/trunk/docs/ref/models/querysets.txt?rev=13235#L138

Something that is both repetitive and doesn't look particularly nice in
the reST source not in the final HTML output:

http://docs.djangoproject.com/en/1.2/ref/models/querysets/#filter-kwargs

Do you think having a mechanism by which e.g. the names of these
functions/methods can appear in the left sidebar local page TOC would be
a desirable change in Sphinx?

Regarding implementation, I don't have too much experience with the
Sphinx code but was thinking on something that would be explicitely
activated, and that would insert the contents of text marked up with
objects description reST in the appropiate places of the local TOC tree.

Regards,

-- 
Ramiro Morales�| http://rmorales.net

-- 
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.

Reply via email to