Skip to content

Commit 961402f

Browse files
committed
added readme to describe doc organization
svn path=/trunk/matplotlib/; revision=5270
1 parent 2d6eb7f commit 961402f

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

doc/README.txt

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
maptlotlib documentation
2+
========================
3+
4+
This is the top level build directory for the matplotlib
5+
documentation. All of the documentation is written using sphinx, a
6+
python documentation system built on top of ReST.
7+
8+
If you are looking for plain text documentation, you can read the following
9+
10+
* users - the user documentation, eg plotting tutorials, configuration
11+
tips, etc.
12+
13+
* devel - documentation for matplotlib developers
14+
15+
* faq - frequently asked questions
16+
17+
* api - placeholders to automatically generate the api documentation
18+
19+
* make.py - the build script to build the html or PDF docs
20+
21+
* index.rst - the top level include document for matplotlib docs
22+
23+
* conf.py - the sphinx configuration
24+
25+
* _static - used by the sphinx build system
26+
27+
* _templates - used by the sphinx build system
28+
29+
* sphinxext - Sphinx extensions for the mpl docs
30+
31+
* mpl_data - a symbolic link to the matplotlib data for reference by
32+
sphinx documentation
33+
34+
* mpl_examples - a link to the matplotlib examples in case any
35+
documentation wants to literal include them

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@
141141
# (source start file, target name, title, author, document class [howto/manual]).
142142

143143
latex_documents = [
144-
('index', 'Matplotlib.tex', 'Matplotlib', 'John Hunter, Darren Dale, Michael Droettboom', 'manual'),
144+
('index', 'Matplotlib.tex', 'Matplotlib', 'Darren Dale, Michael Droettboom, Eric Firing, John Hunter', 'manual'),
145145
]
146146

147147

0 commit comments

Comments
 (0)