edd69bf358
When running 'find cinder/' on OSX platforms, all returned paths will have 2 slashes (//). Because the script only strips the first slash as per the CINDER_DIR value, we end up with module names such as "cinder..db.api" in the documentation. This change trims the leading dot if found to avoid this situation. Change-Id: I9423b253d9842295850f469757e928bf5856967a |
||
|---|---|---|
| .. | ||
| 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!