awips2/pythonPackages/matplotlib/doc
Matt Nash 82300ccdcf Moving 12.1.1 into ss_sync
Former-commit-id: 580e2938d7 [formerly 66be3bec40] [formerly c83e5ff474 [formerly 2a9569942c48542cf708b6c0b9189146fd954c11]]
Former-commit-id: c83e5ff474
Former-commit-id: 1faae42484
2012-01-19 11:53:12 -06:00
..
_static Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
_templates Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
api Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
devel Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
faq Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
glossary Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
mpl_examples Moving 12.1.1 into ss_sync 2012-01-19 11:53:12 -06:00
mpl_toolkits Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
pyplots Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
sphinxext Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
users Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
utils Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
conf.py Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
contents.rst Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
make.py Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
matplotlibrc Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00
README.txt Initial revision of AWIPS2 11.9.0-7p5 2012-01-06 08:55:05 -06:00

maptlotlib documentation
========================

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, eg plotting tutorials, configuration
  tips, etc.

* devel - documentation for matplotlib developers

* faq - frequently asked questions

* api - placeholders to automatically generate the api documentation

* make.py - the build script to build the html or PDF docs

* index.rst - the top level include document for matplotlib docs

* conf.py - the sphinx configuration

* _static - used by the sphinx build system

* _templates - used by the sphinx build system

* sphinxext - Sphinx extensions for the mpl docs

* mpl_examples - a link to the matplotlib examples in case any
  documentation wants to literal include them

To build the HTML documentation, install sphinx (0.5 or greater
required), then type "python make.py html" in this directory.  Wait
for the initial run (which builds the example gallery) to be done,
then run "python make.py html" again. The top file of the results will
be ./build/html/index.html

To build a smaller version of the documentation (without
high-resolution PNGs and PDF examples), type "python make.py --small
html".