summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2010-07-26 17:58:36 +0000
committerTarmac <>2010-07-26 17:58:36 +0000
commit340f9fc8d63ec931485aba1dcfeccdc1cb3849fa (patch)
tree9ada7a376939d4aac6f29dc8f56bf2c9bcd681b0
parentfd9d15fc6097a60e57f818cee231e4feedb7b856 (diff)
parent87e27afec0c7b683ee35f842abdaccea954f2fba (diff)
downloadnova-340f9fc8d63ec931485aba1dcfeccdc1cb3849fa.tar.gz
nova-340f9fc8d63ec931485aba1dcfeccdc1cb3849fa.tar.xz
nova-340f9fc8d63ec931485aba1dcfeccdc1cb3849fa.zip
Updated doc layout to the Sphinx two-dir layout.
-rw-r--r--doc/.gitignore (renamed from docs/.gitignore)0
-rw-r--r--doc/build/.gitignore (renamed from docs/_build/.gitignore)0
-rw-r--r--doc/source/Makefile (renamed from docs/Makefile)0
-rw-r--r--doc/source/_static/.gitignore (renamed from docs/_static/.gitignore)0
-rw-r--r--doc/source/_templates/.gitignore (renamed from docs/_templates/.gitignore)0
-rw-r--r--doc/source/architecture.rst (renamed from docs/architecture.rst)0
-rw-r--r--doc/source/auth.rst (renamed from docs/auth.rst)0
-rw-r--r--doc/source/binaries.rst (renamed from docs/binaries.rst)0
-rw-r--r--doc/source/compute.rst (renamed from docs/compute.rst)0
-rw-r--r--doc/source/conf.py (renamed from docs/conf.py)12
-rw-r--r--doc/source/endpoint.rst (renamed from docs/endpoint.rst)0
-rw-r--r--doc/source/fakes.rst (renamed from docs/fakes.rst)0
-rw-r--r--doc/source/getting.started.rst (renamed from docs/getting.started.rst)0
-rw-r--r--doc/source/index.rst (renamed from docs/index.rst)1
-rw-r--r--doc/source/modules.rst (renamed from docs/modules.rst)0
-rw-r--r--doc/source/network.rst (renamed from docs/network.rst)0
-rw-r--r--doc/source/nova.rst (renamed from docs/nova.rst)0
-rw-r--r--doc/source/objectstore.rst (renamed from docs/objectstore.rst)0
-rw-r--r--doc/source/packages.rst (renamed from docs/packages.rst)0
-rw-r--r--doc/source/storage.rst (renamed from docs/storage.rst)0
-rw-r--r--doc/source/volume.rst (renamed from docs/volume.rst)0
-rw-r--r--nova/compute/disk.py3
-rw-r--r--setup.cfg4
23 files changed, 10 insertions, 10 deletions
diff --git a/docs/.gitignore b/doc/.gitignore
index 88f9974bd..88f9974bd 100644
--- a/docs/.gitignore
+++ b/doc/.gitignore
diff --git a/docs/_build/.gitignore b/doc/build/.gitignore
index 72e8ffc0d..72e8ffc0d 100644
--- a/docs/_build/.gitignore
+++ b/doc/build/.gitignore
diff --git a/docs/Makefile b/doc/source/Makefile
index b2f74e85a..b2f74e85a 100644
--- a/docs/Makefile
+++ b/doc/source/Makefile
diff --git a/docs/_static/.gitignore b/doc/source/_static/.gitignore
index e69de29bb..e69de29bb 100644
--- a/docs/_static/.gitignore
+++ b/doc/source/_static/.gitignore
diff --git a/docs/_templates/.gitignore b/doc/source/_templates/.gitignore
index e69de29bb..e69de29bb 100644
--- a/docs/_templates/.gitignore
+++ b/doc/source/_templates/.gitignore
diff --git a/docs/architecture.rst b/doc/source/architecture.rst
index 11813d2c8..11813d2c8 100644
--- a/docs/architecture.rst
+++ b/doc/source/architecture.rst
diff --git a/docs/auth.rst b/doc/source/auth.rst
index 70aca704a..70aca704a 100644
--- a/docs/auth.rst
+++ b/doc/source/auth.rst
diff --git a/docs/binaries.rst b/doc/source/binaries.rst
index 90a9581f7..90a9581f7 100644
--- a/docs/binaries.rst
+++ b/doc/source/binaries.rst
diff --git a/docs/compute.rst b/doc/source/compute.rst
index 5b08dbd5b..5b08dbd5b 100644
--- a/docs/compute.rst
+++ b/doc/source/compute.rst
diff --git a/docs/conf.py b/doc/source/conf.py
index fb3fd1a30..1c1ae7f48 100644
--- a/docs/conf.py
+++ b/doc/source/conf.py
@@ -16,8 +16,7 @@ import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath('/Users/jmckenty/Projects/cc'))
-sys.path.append([os.path.abspath('../nova'),os.path.abspath('../'),os.path.abspath('../vendor')])
+sys.path.append([os.path.abspath('../nova'), os.path.abspath('..'), os.path.abspath('../bin')])
# -- General configuration -----------------------------------------------------
@@ -25,7 +24,6 @@ sys.path.append([os.path.abspath('../nova'),os.path.abspath('../'),os.path.abspa
# 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', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
-#sphinx_to_github = False
todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.
@@ -68,7 +66,7 @@ release = '0.42'
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
-exclude_trees = ['_build']
+exclude_trees = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
@@ -176,7 +174,7 @@ htmlhelp_basename = 'novadoc'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'nova.tex', u'nova Documentation',
+ ('index', 'Nova.tex', u'Nova Documentation',
u'Anso Labs, LLC', 'manual'),
]
@@ -199,4 +197,6 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {'python': ('http://docs.python.org/', None),
+ 'swift': ('http://swift.openstack.org', None)}
+
diff --git a/docs/endpoint.rst b/doc/source/endpoint.rst
index 399df4161..399df4161 100644
--- a/docs/endpoint.rst
+++ b/doc/source/endpoint.rst
diff --git a/docs/fakes.rst b/doc/source/fakes.rst
index bea8bc4e9..bea8bc4e9 100644
--- a/docs/fakes.rst
+++ b/doc/source/fakes.rst
diff --git a/docs/getting.started.rst b/doc/source/getting.started.rst
index 3eadd0882..3eadd0882 100644
--- a/docs/getting.started.rst
+++ b/doc/source/getting.started.rst
diff --git a/docs/index.rst b/doc/source/index.rst
index ef2e8f63e..6627fe066 100644
--- a/docs/index.rst
+++ b/doc/source/index.rst
@@ -43,7 +43,6 @@ Contents:
nova
fakes
binaries
- todo
modules
packages
diff --git a/docs/modules.rst b/doc/source/modules.rst
index 82c61f008..82c61f008 100644
--- a/docs/modules.rst
+++ b/doc/source/modules.rst
diff --git a/docs/network.rst b/doc/source/network.rst
index 357a0517f..357a0517f 100644
--- a/docs/network.rst
+++ b/doc/source/network.rst
diff --git a/docs/nova.rst b/doc/source/nova.rst
index 4b9c44a5f..4b9c44a5f 100644
--- a/docs/nova.rst
+++ b/doc/source/nova.rst
diff --git a/docs/objectstore.rst b/doc/source/objectstore.rst
index 6b8d293f4..6b8d293f4 100644
--- a/docs/objectstore.rst
+++ b/doc/source/objectstore.rst
diff --git a/docs/packages.rst b/doc/source/packages.rst
index 6029ad7d7..6029ad7d7 100644
--- a/docs/packages.rst
+++ b/doc/source/packages.rst
diff --git a/docs/storage.rst b/doc/source/storage.rst
index f77e5f0e5..f77e5f0e5 100644
--- a/docs/storage.rst
+++ b/doc/source/storage.rst
diff --git a/docs/volume.rst b/doc/source/volume.rst
index 619968458..619968458 100644
--- a/docs/volume.rst
+++ b/doc/source/volume.rst
diff --git a/nova/compute/disk.py b/nova/compute/disk.py
index 7e31498e5..1ffcca685 100644
--- a/nova/compute/disk.py
+++ b/nova/compute/disk.py
@@ -40,7 +40,8 @@ def partition(infile, outfile, local_bytes=0, local_type='ext2', execute=None):
formatted as ext2.
In the diagram below, dashes represent drive sectors.
- 0 a b c d e
+ +-----+------. . .-------+------. . .------+
+ | 0 a| b c|d e|
+-----+------. . .-------+------. . .------+
| mbr | primary partiton | local partition |
+-----+------. . .-------+------. . .------+
diff --git a/setup.cfg b/setup.cfg
index 278586962..839472544 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,4 +1,4 @@
[build_sphinx]
-source-dir = docs
-build-dir = docs/_build
+source-dir = doc/source
+build-dir = doc/build
all_files = 1