57877615f5
Former-commit-id:2b462d8665[formerly133dc97f67] [formerlya02aeb236c] [formerlya02aeb236c[formerly9f19e3f712]] [formerly2b462d8665[formerly133dc97f67] [formerlya02aeb236c] [formerlya02aeb236c[formerly9f19e3f712]] [formerly06a8b51d6d[formerlya02aeb236c[formerly9f19e3f712] [formerly06a8b51d6d[formerly 64fa9254b946eae7e61bbc3f513b7c3696c4f54f]]]]] Former-commit-id:06a8b51d6dFormer-commit-id:2c3569dd39[formerly9bb8decbcf] [formerly8e80217e59] [formerlye2ecdcfe33[formerly377dcd10b9] [formerly8e80217e59[formerly3360eb6c5f]]] Former-commit-id:e2ecdcfe33[formerly377dcd10b9] Former-commit-id:e2ecdcfe33Former-commit-id:7dbd17a5aa
41 lines
1.3 KiB
Text
Executable file
41 lines
1.3 KiB
Text
Executable file
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".
|