← Back to branch summary

~anso/nova/trunkdoc

« back to all changes in this revision

Viewing changes to doc/README.rst

  • Committer: Todd Willey
  • Date: 2010-11-07 19:22:26 UTC
  • mfrom: (426.1.6 doc_updates)
  • Revision ID: todd@ansolabs.com-20101107192226-m0wim11g9kg73tau
Merge termie's autodoc system into trunkdoc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/README.rst
 
1
=================
 
2
Building the docs
 
3
=================
 
4
 
 
5
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.
 
6
 
 
7
 
 
8
Use `make`
 
9
==========
 
10
 
 
11
Just type make::
 
12
 
 
13
  % make
 
14
 
 
15
Look in the Makefile for more targets.
 
16
 
 
17
 
 
18
Manually
 
19
========
 
20
 
 
21
  1. Generate the code.rst file so that Sphinx will pull in our docstrings::
 
22
     
 
23
      % ./generate_autodoc_index.sh > source/code.rst
 
24
 
 
25
  2. Run `sphinx_build`::
 
26
 
 
27
      % sphinx-build -b html source build/html
 
28
 
 
29
 
 
30
The docs have been built
 
31
========================
 
32
 
 
33
Check out the `build` directory to find them. Yay!