nova/doc at da1a151dfc9ffcb8591fa0972db0a769bd86668a - nova

womax/nova

Files

T

James E. Blair 79807e11a1 Change mycloud.com to example.com (RFC2606).

From RFC2606:
   To reduce the likelihood of conflict and confusion, a few top level
   domain names are reserved for use in private testing, as examples in
   documentation, and the like.

Currently the documentation contains URLs that point to mycloud.com,
which is registered and not affiliated with OpenStack.  It's better
to use example.com which exists for this purpose.

Change-Id: I7ebd9b2c0d650f15e5924798cc54611d47961f8f

2012-03-22 10:52:27 -07:00

build

generated files should not be in source control

2011-06-16 11:07:36 -05:00

ext

Get rid of all of the autodoc import errors.

2012-03-05 20:22:51 -08:00

source

Change mycloud.com to example.com (RFC2606).

2012-03-22 10:52:27 -07:00

.gitignore

Remove contrib/nova.sh and other stale docs.

2011-11-15 16:32:37 -05:00

find_autodoc_modules.sh

Get rid of all of the autodoc import errors.

2012-03-05 20:22:51 -08:00

generate_autodoc_index.sh

Merge "fix restructuredtext formatting in docstrings that show up in the developer guide"

2012-03-07 01:34:42 +00: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

Fix rst formatting and cross-references

2012-03-06 08:08:25 -05:00

README.rst

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

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

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!