Revision: 5734
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5734&view=rev
Author: dsdale
Date: 2008-07-10 11:59:18 -0700 (Thu, 10 Jul 2008)
Log Message:
-----------
minor cleanup in documentation guide
Modified Paths:
--------------
trunk/matplotlib/doc/devel/documenting_mpl.rst
Modified: trunk/matplotlib/doc/devel/documenting_mpl.rst
===================================================================
--- trunk/matplotlib/doc/devel/documenting_mpl.rst 2008-07-10 18:12:50 UTC
(rev 5733)
+++ trunk/matplotlib/doc/devel/documenting_mpl.rst 2008-07-10 18:59:18 UTC
(rev 5734)
@@ -18,8 +18,9 @@
.. _Sphinx: http://sphinx.pocoo.org/
-The documentation sources are found in the `doc/` directory in the trunk.
-To build the users guide in html format, cd into `doc/users_guide` and do::
+The documentation sources are found in the :file:`doc/` directory in the trunk.
+To build the users guide in html format, cd into :file:`doc/` and
+do::
python make.py html
@@ -30,19 +31,20 @@
you can also pass a ``latex`` flag to make.py to build a pdf, or pass no
arguments to build everything.
-The output produced by Sphinx can be configured by editing the `conf.py`
-file located in the `doc/`.
+The output produced by Sphinx can be configured by editing the :file:`conf.py`
+file located in the :file:`doc/`.
Organization of matplotlib's documentation
==========================================
-The actual ReStructured Text files are kept in `doc/users`, `doc/devel`,
-`doc/api` and `doc/faq`. The main entry point is `doc/index.rst`, which pulls
-in the `index.rst` file for the users guide, developers guide, api reference,
-and faqs. The documentation suite is built as a single document in order to
-make the most effective use of cross referencing, we want to make navigating
-the Matplotlib documentation as easy as possible.
+The actual ReStructured Text files are kept in :file:`doc/users`,
+:file:`doc/devel`, :file:`doc/api` and :file:`doc/faq`. The main entry point is
+:file:`doc/index.rst`, which pulls in the :file:`index.rst` file for the users
+guide, developers guide, api reference, and faqs. The documentation suite is
+built as a single document in order to make the most effective use of cross
+referencing, we want to make navigating the Matplotlib documentation as easy as
+possible.
Additional files can be added to the various guides by including their base
file name (the .rst extension is not necessary) in the table of contents.
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Sponsored by: SourceForge.net Community Choice Awards: VOTE NOW!
Studies have shown that voting for your favorite open source project,
along with a healthy diet, reduces your potential for chronic lameness
and boredom. Vote Now at http://www.sourceforge.net/community/cca08
_______________________________________________
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
