Fix rst formatting and cross-references

blueprint sphinx-doc-cleanup
bug 944385

- Fix formatting and markup issues that produce error messages
- Update TOC lists for missing/new files
- Fix a few links
- Update instructions with dependencies for building the documentation
- Updated base on review comments from oubiwann to fix trailing whitespace in modified files

Change-Id: I589152bfab9c543d2b11fa8bed2344259aa90675
This commit is contained in:
Doug Hellmann 2012-03-01 16:54:28 -05:00 committed by Lorin Hochstein
parent d14bbbd62f
commit 869b1c2250
3 changed files with 33 additions and 5 deletions

View File

@ -2,7 +2,29 @@
Building the docs
=================
It is really easy. 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.
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`

View File

@ -78,7 +78,12 @@ version = nova_version.canonical_version_string()
#today_fmt = '%B %d, %Y'
# List of documents that shouldn't be included in the build.
#unused_docs = []
unused_docs = [
'api_ext/rst_extension_template',
'man/novamanage',
'vmwareapi_readme',
'installer',
]
# List of directories, relative to source directory, that shouldn't be searched
# for source files.

View File

@ -48,12 +48,13 @@ Key Concepts
cloud101
nova.concepts
swift.concepts
service.architecture
nova.object.model
swift.object.model
object.model
runnova/index
.. swift.concepts
.. swift.object.model
Developer Docs
==============