nova/doc at cbcda1ec466fd498fb8e9fe47c72b52c2d4b3dde - nova

womax/nova

Files

T

sateesh cbcda1ec46 1) Update few comments where whitespace is missing after '#'

2) Update document so that copy right notice doesn't appear in generated document
3) Now using self.flag(...) instead of setting the flags like FLAGS.vmwareapi_username by direct assignment.
4) Added the missing double quote at the end a string in vim_util.py

2011-03-17 20:13:48 +05:30

build

Removing pesky DS_Store files too. Begone.

2011-02-21 14:35:30 -06:00

ext

Completed first pass at converting all localized strings with multiple format substitutions.

2011-01-18 21:00:28 -05:00

source

1) Update few comments where whitespace is missing after '#'

2011-03-17 20:13:48 +05:30

.autogenerated

adding new source docs

2011-03-02 16:57:56 -08:00

.gitignore

Updated sphinx layout to a two-dir layout like swift.

2010-07-24 18:06:22 -07:00

find_autodoc_modules.sh

quieter doc building (less warnings).

2010-11-07 14:58:02 -05:00

generate_autodoc_index.sh

Cleanups to doc process.

2010-11-07 15:14:58 -05:00

Makefile

Since we're autodocumenting from a sphinx ext, we can scrap it in Makefile.

2010-11-07 18:18:04 -05:00

README.rst

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

2010-11-07 14:51:40 -05:00

README.rst

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