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

Skip to content

Commit 23f4757

Browse files
authored
Update documenting_mpl.rst
1 parent 530c62d commit 23f4757

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

doc/devel/documenting_mpl.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Getting started
1010
Installing dependencies
1111
-----------------------
1212

13-
The documentation for matplotlib is generated from ReStructured Text using the
13+
The documentation for matplotlib is generated from reStructuredText using the
1414
Sphinx_ documentation generation tool. There are several extra requirements that
1515
are needed to build the documentation. They are listed in the file
1616
`doc-requirements.txt <https://github.com/matplotlib/matplotlib/blob/master/doc-requirements.txt>`_
@@ -26,26 +26,26 @@ as well as listed below:
2626

2727
.. note::
2828

29-
* You'll need a minimal working latex distribution for many examples to run.
30-
* `Graphviz <http://graphviz.readthedocs.io/en/latest/manual.html>`_ is not pip-installable so you need
29+
* You'll need a minimal working LaTeX distribution for many examples to run.
30+
* `Graphviz <http://www.graphviz.org/Download.php>`_ is not pip-installable so you need
3131
to install this on your own.
3232

3333
General structure
3434
-----------------
3535

36-
All documentation is built from the :file:`doc/` directory. This folder contains both
37-
``.rst`` files that contain pages in the documentation, folders that contain more
36+
All documentation is built from the :file:`doc/` directory. This directory contains both
37+
``.rst`` files that contain pages in the documentation, directory that contain more
3838
``.rst`` files, and configuration files for Sphinx.
3939

4040
.. note::
4141

42-
An exception to this are the folders :file:`gallery` and :file:`tutorials`, which
43-
exist in the root folder. These contain python files that are built by ``sphinx-gallery``.
44-
When the docs are built, folders of the same name will be generated inside of :file:`docs/`.
45-
The generated folders :file:`docs/gallery` and :file:`docs/tutorials` can be safely deleted.
42+
An exception to this are the directories :file:`gallery` and :file:`tutorials`, which
43+
exist in the root directory. These contain Python files that are built by ``sphinx-gallery``.
44+
When the docs are built, directory of the same name will be generated inside of :file:`docs/`.
45+
The generated directories :file:`docs/gallery` and :file:`docs/tutorials` can be safely deleted.
4646

47-
The configuration file for Sphinx is :file:`doc/conf.py`. It controls which folders
48-
sphinx parses, how the docs are built, and how the extensions are used.
47+
The configuration file for Sphinx is :file:`doc/conf.py`. It controls which directory
48+
Sphinx parses, how the docs are built, and how the extensions are used.
4949

5050
Building the docs
5151
-----------------
@@ -63,14 +63,14 @@ or::
6363
There are many other flags you can pass to ``make.py``, and you can see the
6464
full list inside that file. Here are two useful ones:
6565

66-
* ``clean`` will delete the built sphinx files. Use this command if you're getting strange
66+
* ``clean`` will delete the built Sphinx files. Use this command if you're getting strange
6767
errors about missing paths or broken links, particularly if you move files around.
68-
* ``latex`` builds a pdf of the documentation.
68+
* ``latex`` builds a PDF of the documentation.
6969

7070
In addition, these are useful flags:
7171

7272
* ``--help`` will (among other things) display the allowed commands for ``make.py``.
73-
* ``--allowsphinxwarnings`` will allow the docs to continue building even if sphinx
73+
* ``--allowsphinxwarnings`` will allow the docs to continue building even if Sphinx
7474
throws a warning. This is useful for debugging and spot-checking many warnings
7575
at once.
7676

0 commit comments

Comments
 (0)