diff --git a/docs/README.rst b/docs/README.rst index 7e5229a1..4ded7b03 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -14,17 +14,9 @@ Sphinx_ pip install Sphinx -Graphviz_ - Some of the diagrams are generated using the ``dot`` language - from Graphviz. - - :: - - sudo apt-get install graphviz .. _Sphinx: http://sphinx.pocoo.org -.. _Graphviz: http://www.graphviz.org/ Use `make` @@ -32,24 +24,10 @@ Use `make` Just type make:: - % make + % make html Look in the Makefile for more targets. -Manually -======== - - 1. Generate the code.rst file so that Sphinx will pull in our docstrings:: - - % ./generate_autodoc_index.sh > source/code.rst - - 2. Run `sphinx_build`:: - - % sphinx-build -b html source build/html - - -The docs have been built -======================== Check out the `build` directory to find them. Yay!