762f2e19cf
Way back when Cinder was inagurated as a separate project, the docs directory from Nova was used as a seed for the one in the Cinder repo This patch is simply cleaning out images and files which have no relation to Cinder at all, and are at best extremely outdated when applied to Nova. Aside from the deletions which are mainly images, and files related to the configuration of CloudPipe, there is one modification to conf.py which simply removes a reference to a vmware doc that no longer exists. Change-Id: I2140035f98bd332f25d7dd7569993bcd960a869e |
||
|---|---|---|
| .. | ||
| ext | ||
| source | ||
| .gitignore | ||
| Makefile | ||
| README.rst | ||
| find_autodoc_modules.sh | ||
| generate_autodoc_index.sh | ||
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
dotlanguage from Graphviz.sudo apt-get install graphviz
Use make
Just type make:
% makeLook in the Makefile for more targets.
Manually
Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.sh > source/code.rstRun `sphinx_build`:
% sphinx-build -b html source build/html
The docs have been built
Check out the build directory to find them. Yay!