Removed a bunch of cruft files.
Ohai. We dont't uses any of theses anymores. Let's just make buh-bye. Change-Id: Ib81c92ab9196552150d81d158befb0747966965d
This commit is contained in:
@@ -1,55 +0,0 @@
|
||||
=================
|
||||
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 nova modules.
|
||||
|
||||
::
|
||||
|
||||
pip install Sphinx
|
||||
|
||||
Graphviz_
|
||||
Some of the diagrams are generated using the ``dot`` language
|
||||
from Graphviz.
|
||||
|
||||
::
|
||||
|
||||
sudo apt-get install graphviz
|
||||
|
||||
.. _Sphinx: http://sphinx.pocoo.org
|
||||
|
||||
.. _Graphviz: http://www.graphviz.org/
|
||||
|
||||
|
||||
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!
|
||||
Reference in New Issue
Block a user