About two months ago I was asking how to implement the following
functionality for matplotlib documentation. Well today I figured it
out I was busy with some other school work not been thinking for
over twom months
"Is there a way to get functions separately listed under each bookmark
listing in the pdf file? For example if I go IV Matplotlib API section
from the bookmarks menu and click the matplotlib.pyplot seb-menu I
would like to see the function names listed. In addition to module
indexing (where keywords highlighted back to original names) this
would be a nice feature to add the pdf documentation."
Enough said, here is what I did. (Thanks to Georg Brandl of Sphinx)
(As of now the latest svn checkout 0.98.6svn_rev__7068 although
__revision__ says: 6887, and with Sphinx 0.6.1)
I have modified the pyplot_api.rst as follows:
.. automodule:: matplotlib.pyplot
.. autofunction:: acorr
.. autofunction:: annotate
and other 121 manual entries. (The new PDF file is 12 pages more than
original file.) While I was adding the function names I thought of
myself that these could be done via a little program. I mean before
Sphinx visit --in this case pyplot.py function names might read into a
list and following this an appropriate rst file could be created (and
this is also apply for the other api documentation as well). Or
another way, these could be added to Sphinx as a feature, that is to
say read function names and read docstrings, create figures etc.. and
make a subsection for each item via a special syntax.
The first method eliminates having a pre-written pyplot_api.rst file
since this could be created via a short python script.
I would like discuss these point before start working on other api
functions and classes. Also need some explanation about them, since
pyplot is composed of functions but some other api's are mixed with
classes and functions.
Please, contact me of the list so I can send the modified pyploy_rst.api.