DOC documents the new way of building sphinx-doc

NelleV · NelleV · commit ed05541be821 · 2016-09-08T09:21:51.000-07:00
diff --git a/doc/README.txt b/doc/README.txt
@@ -15,7 +15,7 @@ or conda::
 
   conda install sphinx numpydoc ipython mock colorspacious pillow
 
-To build the HTML documentation, type ``python make.py html`` in this
+To build the HTML documentation, type ``make html`` in this
 directory. The top file of the results will be ./build/html/index.html
 
 **Note that Sphinx uses the installed version of the package to build the
@@ -24,9 +24,8 @@ generated.
 
 You can build the documentation with several options:
 
-* `--small` saves figures in low resolution.
-* `--allowsphinxwarnings`: Don't turn Sphinx warnings into errors.
-* `-n N` enables parallel build of the documentation using N process.
+* `make html-small-plots` saves figures in low resolution.
+* `-j N` enables parallel build of the documentation using N process.
 
 Organization
 -------------
@@ -47,7 +46,7 @@ python documentation system built on top of ReST.  This directory contains
 * mpl_toolkits - documentation of individual toolkits that ship with
   matplotlib
 
-* make.py - the build script to build the html or PDF docs
+* Makefile and make.bat - the build script to build the html or PDF docs
 
 * index.rst - the top level include document for matplotlib docs
 
@@ -61,4 +60,3 @@ python documentation system built on top of ReST.  This directory contains
 
 * mpl_examples - a link to the matplotlib examples in case any
   documentation wants to literal include them
-
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -15,14 +15,9 @@ 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
+  make
 
-or::
-
-  ./make.py html
-
-you can also pass a ``latex`` flag to make.py to build a pdf, or pass no
-arguments to build everything.
+you can also pass a ``latex`` flag to make to build a pdf.
 
 The output produced by Sphinx can be configured by editing the :file:`conf.py`
 file located in the :file:`doc/`.
diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst
@@ -144,8 +144,8 @@ stats for all work done since that release.
 In the matplotlib source repository, build the documentation::
 
   cd doc
-  python make.py html
-  python make.py latex
+  make html
+  make latex
 
 Then copy the build products into your local checkout of the
 `matplotlib.github.com` repository (assuming here to be checked out in
