[Checkins] SVN: zope.interface/trunk/ Run Sphinx commands directly, rather than via 'make'.

Tres Seaver cvs-admin at zope.org
Wed Jun 27 14:40:00 UTC 2012


Log message for revision 127130:
  Run Sphinx commands directly, rather than via 'make'.
  
  Fix a coupld of ReST typos.

Changed:
  _U  zope.interface/trunk/
  U   zope.interface/trunk/docs/hacking.rst

-=-
Modified: zope.interface/trunk/docs/hacking.rst
===================================================================
--- zope.interface/trunk/docs/hacking.rst	2012-06-27 14:39:51 UTC (rev 127129)
+++ zope.interface/trunk/docs/hacking.rst	2012-06-27 14:39:56 UTC (rev 127130)
@@ -60,7 +60,7 @@
    OK
 
 The ``dev`` command alias downloads and installs extra tools, like the
-`:mod:nose` testrunner and the `:mod:coverage` coverage analyzer:
+:mod:`nose` testrunner and the :mod:`coverage` coverage analyzer:
 
 .. code-block:: sh
 
@@ -114,29 +114,23 @@
 for building its docs.  Using the same virtualenv you set up to run the
 tests, you can build the docs:
 
-The ``dev`` command alias downloads and installs extra tools, like the
-`:mod:nose` testrunner and the `:mod:coverage` coverage analyzer:
+The ``docs`` command alias downloads and installs Sphinx and its dependencies:
 
 .. code-block:: sh
 
    $ /tmp/hack-zope.interface/bin/python setup.py docs
    ...
-   $ cd docs
-   $ PATH=/tmp/hack-zope.interface/bin:$PATH make html
-   sphinx-build -b html -d _build/doctrees   . _build/html
+   $ bin/sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
    ...
    build succeeded.
 
-   Build finished. The HTML pages are in _build/html.
+   Build finished. The HTML pages are in docs/_build/html.
 
 You can also test the code snippets in the documentation:
 
-.. TODO:: verify this!
-
 .. code-block:: sh
 
-   $ PATH=/tmp/hack-zope.interface/bin:$PATH make doctest
-   sphinx-build -b doctest -d _build/doctrees   . _build/doctest
+   $ bin/sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest
    ...
    running tests...
 
@@ -155,7 +149,7 @@
        0 failures in setup code
    build succeeded.
    Testing of doctests in the sources finished, look at the  \
-       results in _build/doctest/output.txt.
+       results in docs/_build/doctest/output.txt.
 
 
 Running the tests using  :mod:`zc.buildout`



More information about the checkins mailing list