[pypy-svn] pypy default: Fixed docs on how to build the documentation

berdario commits-noreply at bitbucket.org
Thu Apr 21 14:19:57 CEST 2011


Author: Dario Bertini <berdario at gmail.com>
Branch: 
Changeset: r43512:c5a73888b9bb
Date: 2011-04-18 20:34 +0200
http://bitbucket.org/pypy/pypy/changeset/c5a73888b9bb/

Log:	Fixed docs on how to build the documentation

diff --git a/pypy/doc/coding-guide.rst b/pypy/doc/coding-guide.rst
--- a/pypy/doc/coding-guide.rst
+++ b/pypy/doc/coding-guide.rst
@@ -1052,8 +1052,8 @@
 ---------------------------------------------------
 
 Most of the PyPy's documentation and website is kept in
-`pypy/documentation` and `pypy/documentation/website` respectively.
-You can simply edit or add '.txt' files which contain ReST-markuped
+`pypy/doc` respectively.
+You can simply edit or add '.rst' files which contain ReST-markuped
 files.  Here is a `ReST quickstart`_ but you can also just look
 at the existing documentation and see how things work.
 
@@ -1062,25 +1062,24 @@
 Automatically test documentation/website changes
 ------------------------------------------------
 
-.. _`docutils home page`:
-.. _`docutils`: http://docutils.sourceforge.net/
+.. _`sphinx home page`:
+.. _`sphinx`: http://sphinx.pocoo.org/
 
 We automatically check referential integrity and ReST-conformance.  In order to
-run the tests you need docutils_ installed.  Then go to the local checkout
-of the documentation directory and run the tests::
+run the tests you need sphinx_ installed.  Then go to the local checkout
+of the documentation directory and run the Makefile::
 
-    cd .../pypy/documentation
-    python ../test_all.py
+    cd pypy/doc
+    make html
 
 If you see no failures chances are high that your modifications at least
-don't produce ReST-errors or wrong local references.  A side effect of running
-the tests is that you have `.html` files in the documentation directory
-which you can point your browser to!
+don't produce ReST-errors or wrong local references. Now you will have `.html`
+files in the documentation directory which you can point your browser to!
 
 Additionally, if you also want to check for remote references inside
 the documentation issue::
 
-    python ../test_all.py --checkremote
+    make linkcheck
 
 which will check that remote URLs are reachable.
 


More information about the Pypy-commit mailing list