anvil/docs/README.rst

34 lines
483 B
ReStructuredText
Raw Normal View History

2012-03-30 20:59:29 +00:00
=================
Building the docs
=================
Dependencies
============
Sphinx_
You'll need sphinx (the python one) and if you are
using the virtualenv you'll need to install it in the virtualenv
specifically so that it can load the nova modules.
::
pip install Sphinx
.. _Sphinx: http://sphinx.pocoo.org
Use `make`
==========
Just type make::
2012-03-30 22:00:38 +00:00
% make html
2012-03-30 20:59:29 +00:00
Look in the Makefile for more targets.
Check out the `build` directory to find them. Yay!