Skip to content

Commit

Permalink
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
jdh2358 committed May 25, 2008
1 parent 2d6eb7f commit 961402f
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
35 changes: 35 additions & 0 deletions doc/README.txt
@@ -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
2 changes: 1 addition & 1 deletion doc/conf.py
Expand Up @@ -141,7 +141,7 @@
# (source start file, target name, title, author, document class [howto/manual]).

latex_documents = [
('index', 'Matplotlib.tex', 'Matplotlib', 'John Hunter, Darren Dale, Michael Droettboom', 'manual'),
('index', 'Matplotlib.tex', 'Matplotlib', 'Darren Dale, Michael Droettboom, Eric Firing, John Hunter', 'manual'),
]


Expand Down

0 comments on commit 961402f

Please sign in to comment.