forked from matplotlib/matplotlib
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
added readme to describe doc organization
svn path=/trunk/matplotlib/; revision=5270
- Loading branch information
Showing
2 changed files
with
36 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
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. | ||
|
||
If you are looking for plain text documentation, you can read the following | ||
|
||
* 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_data - a symbolic link to the matplotlib data for reference by | ||
sphinx documentation | ||
|
||
* mpl_examples - a link to the matplotlib examples in case any | ||
documentation wants to literal include them |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters