You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
cinder/doc
Atsushi SAKAI a544f5cbb2
Rename filename from il8n.rst to i18n.rst
8 years ago
..
ext Replace xrange() with six.moves.range() 8 years ago
source Rename filename from il8n.rst to i18n.rst 8 years ago
.gitignore Initial fork out of Nova. 11 years ago
Makefile Initial fork out of Nova. 11 years ago
README.rst Complete the doc/README.rst instructions to build docs 8 years ago
find_autodoc_modules.sh Fixes a small issue in find_autodoc_modules.sh 8 years ago
generate_autodoc_index.sh Initial fork out of Nova. 11 years ago

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

Use tox

The easiest way to build the docs and avoid dealing with all dependencies is to let tox prepare a virtualenv and run the build_sphinx target inside the virtualenv:

% cd ..
% tox -e docs

The docs have been built

Check out the build directory to find them. Yay!