c30ce044b7
We were planning to let the list targets call be a free for all, and just be a generic dict of info. This probably isn't such a great idea, inparticular since we have a required identifier field for each replication device it makes more sense to just use that in the response and leave the rest of the info internal. In the future if there's a need we can always implement a show command that displays all the dirty details. This patch changes the identifier name to 'target_device_id' to be more self describing, and updates the docstrings and devref docs to reflect the changes and agreed upon changes. Change-Id: If14130f5d5bb2e6df4478bd0e14a1f33d706bf78 |
||
|---|---|---|
| .. | ||
| ext | ||
| source | ||
| .gitignore | ||
| find_autodoc_modules.sh | ||
| generate_autodoc_index.sh | ||
| Makefile | ||
| 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
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 docsThe docs have been built
Check out the build directory to find them. Yay!