Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit aac37ca

Browse files
committed
minor cleanup in documentation guide
svn path=/trunk/matplotlib/; revision=5734
1 parent 2bb054c commit aac37ca

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

doc/devel/documenting_mpl.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ repository by doing::
1818

1919
.. _Sphinx: http://sphinx.pocoo.org/
2020

21-
The documentation sources are found in the `doc/` directory in the trunk.
22-
To build the users guide in html format, cd into `doc/users_guide` and do::
21+
The documentation sources are found in the :file:`doc/` directory in the trunk.
22+
To build the users guide in html format, cd into :file:`doc/` and
23+
do::
2324

2425
python make.py html
2526

@@ -30,19 +31,20 @@ or::
3031
you can also pass a ``latex`` flag to make.py to build a pdf, or pass no
3132
arguments to build everything.
3233

33-
The output produced by Sphinx can be configured by editing the `conf.py`
34-
file located in the `doc/`.
34+
The output produced by Sphinx can be configured by editing the :file:`conf.py`
35+
file located in the :file:`doc/`.
3536

3637

3738
Organization of matplotlib's documentation
3839
==========================================
3940

40-
The actual ReStructured Text files are kept in `doc/users`, `doc/devel`,
41-
`doc/api` and `doc/faq`. The main entry point is `doc/index.rst`, which pulls
42-
in the `index.rst` file for the users guide, developers guide, api reference,
43-
and faqs. The documentation suite is built as a single document in order to
44-
make the most effective use of cross referencing, we want to make navigating
45-
the Matplotlib documentation as easy as possible.
41+
The actual ReStructured Text files are kept in :file:`doc/users`,
42+
:file:`doc/devel`, :file:`doc/api` and :file:`doc/faq`. The main entry point is
43+
:file:`doc/index.rst`, which pulls in the :file:`index.rst` file for the users
44+
guide, developers guide, api reference, and faqs. The documentation suite is
45+
built as a single document in order to make the most effective use of cross
46+
referencing, we want to make navigating the Matplotlib documentation as easy as
47+
possible.
4648

4749
Additional files can be added to the various guides by including their base
4850
file name (the .rst extension is not necessary) in the table of contents.

0 commit comments

Comments
 (0)