diff --git a/doc/README.rst b/doc/README.rst index 565e8d5bf..7e5229a1a 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -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` diff --git a/doc/source/conf.py b/doc/source/conf.py index 99baf9e78..2b337771d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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. diff --git a/doc/source/index.rst b/doc/source/index.rst index e16cd3dc4..ac481dee9 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ==============