openstack/placement
Code Issues Proposed changes

Merge lp:~termie/nova/trunkdoc (via patch, since bzr though it was already merged)

Browse Source
This commit is contained in:
Todd Willey 2010-11-07 14:51:40 -05:00
parent 4b0b8c7a98
commit 3651277b37
2 changed files with 34 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/README.rst Normal file
View File

@ -0,0 +1,33 @@
=================
Building the docs
=================
It is really easy. 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.
Use `make`
==========
Just type make::
% make
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!

2
doc/source/index.rst
View File

@ -45,7 +45,7 @@ Contents
concepts.and.introduction
adminguide/index
devguide/index
devref/index
reaching.out
Recommended System Configuration