deb-manila/doc
Alfredo Moralejo cb1a69082c Fixed references for scheduler drivers in doc
References for base and simple scheduler drivers must
reference to the right location in drivers folder.

Change-Id: I7698efd9c656c1204641567b1009ad270a20aa21
2016-05-09 19:29:19 +02:00
..
ext py3: use six.moves.range instead of xrange 2014-12-27 18:41:21 +08:00
source Fixed references for scheduler drivers in doc 2016-05-09 19:29:19 +02:00
.gitignore Initialize from cinder 2013-08-08 10:34:06 -04:00
find_autodoc_modules.sh docs 2013-09-17 10:57:47 +03:00
generate_autodoc_index.sh modified docs 2013-09-17 12:21:17 +03:00
Makefile docs 2013-09-17 10:57:47 +03:00
README.rst docs 2013-09-17 10:57:47 +03: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 manila modules.

pip install Sphinx
Graphviz

Some of the diagrams are generated using the dot language from Graphviz.

sudo apt-get install graphviz

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!