diff options
| author | root <root@tonbuntu> | 2010-11-12 10:02:03 -0800 |
|---|---|---|
| committer | root <root@tonbuntu> | 2010-11-12 10:02:03 -0800 |
| commit | 7915fd554ef8236589863f32a0bc0d4406e2db0b (patch) | |
| tree | 58d109c335f2c140a19997719fbc50ce5b081e6b /doc/source | |
| parent | eecb36c85f4a797546348801dce2f1d8d4285e61 (diff) | |
| download | nova-7915fd554ef8236589863f32a0bc0d4406e2db0b.tar.gz nova-7915fd554ef8236589863f32a0bc0d4406e2db0b.tar.xz nova-7915fd554ef8236589863f32a0bc0d4406e2db0b.zip | |
create SPHINX_DEBUG env var. Setting this will disable aggressive autodoc generation. Also provide some sample for P syntax
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/conf.py | 8 | ||||
| -rw-r--r-- | doc/source/quickstart.rst | 4 | ||||
| -rw-r--r-- | doc/source/service.architecture.rst | 2 |
3 files changed, 10 insertions, 4 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 388aaabc2..f2e768d71 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -24,7 +24,13 @@ sys.path.insert(0, os.path.abspath('./')) # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'ext.nova_todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig','sphinx.ext.graphviz', 'ext.nova_autodoc'] + +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'ext.nova_todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig','sphinx.ext.graphviz'] + +# autodoc generation is a bit aggressive and a nuisance when doing heavy text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable +if 'SPHINX_DEBUG' not in os.environ.keys(): + extensions += ['ext.nova_autodoc'] todo_include_todos = True diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst index dcf4ba2c4..22e026ce7 100644 --- a/doc/source/quickstart.rst +++ b/doc/source/quickstart.rst @@ -18,8 +18,8 @@ Nova Quickstart =============== -.. todo:: - +.. todo:: + P1 (this is one example of how to use priority syntax) * Document the assumptions about pluggable interfaces (sqlite3 instead of mysql, etc) (todd) * Document env vars that can change things (USE_MYSQL, HOST_IP) (todd) diff --git a/doc/source/service.architecture.rst b/doc/source/service.architecture.rst index b621dcfa5..df8edf864 100644 --- a/doc/source/service.architecture.rst +++ b/doc/source/service.architecture.rst @@ -57,4 +57,4 @@ Volume Workers interact with iSCSI storage to manage LVM-based [#f89]_ instance Volumes may easily be transferred between instances, but may be attached to only a single instance at a time. -.. todo:: image store description +.. todo:: P2: image store description |