Commits

Dario Bertini committed 1b14679

Fixed docs on how to build the documentation

Comments (0)

Files changed (1)

pypy/doc/coding-guide.rst

 ---------------------------------------------------
 
 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.
 
 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.
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.