@@ -28,14 +28,13 @@ as well as listed below:
2828
2929 * You'll need a minimal working latex distribution for many examples to run.
3030 * `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/ >`_.
31+ to install this on your own.
3332
3433General structure
3534-----------------
3635
3736All documentation is built from the :file: `doc/ ` directory. This folder contains both
38- ``.rst `` files that contains pages in the documentation, folders that contain more
37+ ``.rst `` files that contain pages in the documentation, folders that contain more
3938``.rst `` files, and configuration files for Sphinx.
4039
4140.. note ::
@@ -45,7 +44,7 @@ All documentation is built from the :file:`doc/` directory. This folder contains
4544 When the docs are built, folders of the same name will be generated inside of :file: `docs/ `.
4645 The generated folders :file: `docs/gallery ` and :file: `docs/tutorials ` can be safely deleted.
4746
48- The configuration file for Sphinx is in :file: `doc/conf.py `. It controls which folders
47+ The configuration file for Sphinx is :file: `doc/conf.py `. It controls which folders
4948sphinx parses, how the docs are built, and how the extensions are used.
5049
5150Building the docs
@@ -70,6 +69,7 @@ full list inside that file. Here are two useful ones:
7069
7170In addition, these are useful flags:
7271
72+ * ``--help `` will (among other things) display the allowed commands for ``make.py ``.
7373* ``--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.
0 commit comments