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

Skip to content

Commit 0baccc7

Browse files
authored
addressing comments
1 parent 83129fa commit 0baccc7

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

doc/devel/documenting_mpl.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,23 @@ as well as listed below:
2727
.. note::
2828

2929
* You'll need a minimal working latex distribution for many examples to run.
30-
* Graphviz is not pip-installable so you need to install this on your own.
30+
* `Graphviz <http://graphviz.readthedocs.io/en/latest/manual.html>`_ is not pip-installable so you need
31+
to install this on your own. This is straightforward with something like
32+
the `anaconda distribution <https://anaconda.org/>`_.
3133

3234
General structure
3335
-----------------
3436

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

3941
.. note::
4042

4143
An exception to this are the folders :file:`gallery` and :file:`tutorials`, which
4244
exist in the root folder. These contain python files that are built by ``sphinx-gallery``.
4345
When the docs are built, folders of the same name will be generated inside of :file:`docs/`.
44-
These can be safely deleted.
46+
The generated folders :file:`docs/gallery` and :file:`docs/tutorials` can be safely deleted.
4547

4648
The configuration file for Sphinx is in :file:`doc/conf.py`. It controls which folders
4749
sphinx parses, how the docs are built, and how the extensions are used.
@@ -62,9 +64,9 @@ or::
6264
There are many other flags you can pass to ``make.py``, and you can see the
6365
full list inside that file. Here are two useful ones:
6466

65-
* ``clean`` will delete the built sphinx files. Call if you're getting strange
67+
* ``clean`` will delete the built sphinx files. Use this command if you're getting strange
6668
errors about missing paths or broken links, particularly if you move files around.
67-
* ``latex`` builds a pdf of the documentation
69+
* ``latex`` builds a pdf of the documentation.
6870

6971
In addition, these are useful flags:
7072

0 commit comments

Comments
 (0)