1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
|
Matplotlib documentation
========================
Building the documentation
--------------------------
See :file:`doc/devel/documenting_mpl.rst` for instructions to build the docs.
Organization
------------
This is the top level build directory for the Matplotlib
documentation. All of the documentation is written using sphinx, a
python documentation system built on top of ReST. This directory contains
* users - the user documentation, e.g., plotting tutorials, configuration
tips, etc.
* devel - documentation for Matplotlib developers
* faq - frequently asked questions
* api - placeholders to automatically generate the api documentation
* mpl_toolkits - documentation of individual toolkits that ship with
Matplotlib
* index.rst - the top level include document for Matplotlib docs
* conf.py - the sphinx configuration
* Makefile and make.bat - entry points for building the docs
* _static - used by the sphinx build system
* _templates - used by the sphinx build system
* sphinxext - Sphinx extensions for the mpl docs
|