openstack/manila
Code Issues Proposed changes
06a8dc7ae5
manila/doc
History
Andreas Jaeger 98161fabb9 Fix doc build 
Fix the following that shows up when running "python setup.py
build_sphinx":
manila/doc/source/adminref/index.rst:16:
WARNING: toctree contains reference to nonexisting document
u'adminref/launchpad'
manila/doc/source/adminref/index.rst:16:
WARNING: toctree contains reference to nonexisting document
u'adminref/gerrit'
manila/doc/source/adminref/index.rst:16:
WARNING: toctree contains reference to nonexisting document
u'adminref/jenkins'

checking consistency...
manila/doc/source/adminref/index.rst::
WARNING: document isn't included in any toctree

Cleanup adminref/index.rst file and remove content that is duplicated
from the devref/index.rst and not relevant here.

Change-Id: I57accea0f041ac59e507e4cf6461d2239f60b3b7
2014-10-14 21:16:24 +02:00
..
ext Update manila's docs 2014-06-23 19:19:28 +03:00
source Fix doc build 2014-10-14 21:16:24 +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

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