On Mon, May 16, 2011 at 2:52 PM, Eric Firing <efir...@hawaii.edu> wrote:
>
> I had no idea this would open such a big can of worms! The strategy
> question here is, what do we want to include in the html API docs?
>
> It looks like the process of setting up the sphinx API docs was never
> completed; the present set of modules that are included ranges from the
> fundamental (e.g. figure.py) to the peripheral (e.g. afm.py), but I
> doubt that text.py, for example, was deliberately excluded.
>
> I don't see any major disadvantage to including all modules. It might
> make sense to present them in categories, though, instead of dumping
> them all into a single alphabetical list.
>
> Perhaps Mike and John will have sage advice.
>
Not all of the doc strings have been converted to rest. Back when I was
actively working on the docs, I would add a module to the API table of
contents when I had at least done a first pass at converting the docs to
rest. This isn't a requirement, but it helps explain why some modules and
not others are in the list.
------------------------------------------------------------------------------
Achieve unprecedented app performance and reliability
What every C/C++ and Fortran developer should know.
Learn how Intel has extended the reach of its next-generation tools
to help boost performance applications - inlcuding clusters.
http://p.sf.net/sfu/intel-dev2devmay
_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matplotlib-devel
