x
/
anvil
Code Issues Proposed changes

Update docs/README.rst

This commit is contained in:
Joshua Harlow 2012-03-30 15:00:38 -07:00
parent 2fd5d7fd16
commit 117a81f05a
1 changed files with 1 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/README.rst
View File

@ -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!