On Wed, Dec 8, 2010 at 5:42 AM, Nathann Cohen <nathann.co...@gmail.com>wrote:

> Hello everybody !!!
>
> As the subject says, I am interested in knowing whether there is a way
> to ask Sphinx to produce a page per method of a Python class, and
> replace a LOONG description of all the methods by links toward the
> individual pages. Here is my problem :
>
> http://www.sagemath.org/doc/reference/sage/graphs/graph.html
>
> All the methods present there are dealing with the Graph objects of
> Sage (http://www.sagemath.org/), but they are doing many different
> things with them. The trouble now is that it is quite impossible at
> the moment to find *one* of them through Google, as this page contains
> the description of ALL our graph functions. If you were to type
> several keywords in Google, this page would always appear because it
> contains all the corresponding terms, but they would probably be
> scattered inside, and finding the method you are interested in is
> becoming harder. If it was possible, instead, to have just one page
> per method, Google would redirect you immediately toward the good
> method if the keywords are good enough, which would be just GREAT. :-)
>
> Thank you very much for your help, and Sphinx in general. Fantastic
> tool !
>
> Nathann
>
>
Have you tried using the autosummary extension (
http://sphinx.pocoo.org/ext/autosummary.html#directive-autosummary) with the
toctree directive?

You can use the sphinx-autogen script or the autosummary_generate config
option to generate the stub pages for you as well.

Kevin Horn

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to