From 613236aebc471e9a95c501d0c8686a65f19cfd7f Mon Sep 17 00:00:00 2001 From: Monty Taylor Date: Sat, 24 Jul 2010 18:06:22 -0700 Subject: [PATCH] Updated sphinx layout to a two-dir layout like swift. Updated a doc string to get rid of a Sphinx warning. --- {docs => doc}/.gitignore | 0 {docs/_build => doc/build}/.gitignore | 0 {docs => doc/source}/Makefile | 0 {docs => doc/source}/_static/.gitignore | 0 {docs => doc/source}/_templates/.gitignore | 0 {docs => doc/source}/architecture.rst | 0 {docs => doc/source}/auth.rst | 0 {docs => doc/source}/binaries.rst | 0 {docs => doc/source}/compute.rst | 0 {docs => doc/source}/conf.py | 12 ++++++------ {docs => doc/source}/endpoint.rst | 0 {docs => doc/source}/fakes.rst | 0 {docs => doc/source}/getting.started.rst | 0 {docs => doc/source}/index.rst | 1 - {docs => doc/source}/modules.rst | 0 {docs => doc/source}/network.rst | 0 {docs => doc/source}/nova.rst | 0 {docs => doc/source}/objectstore.rst | 0 {docs => doc/source}/packages.rst | 0 {docs => doc/source}/storage.rst | 0 {docs => doc/source}/volume.rst | 0 setup.cfg | 4 ++-- 22 files changed, 8 insertions(+), 9 deletions(-) rename {docs => doc}/.gitignore (100%) rename {docs/_build => doc/build}/.gitignore (100%) rename {docs => doc/source}/Makefile (100%) rename {docs => doc/source}/_static/.gitignore (100%) rename {docs => doc/source}/_templates/.gitignore (100%) rename {docs => doc/source}/architecture.rst (100%) rename {docs => doc/source}/auth.rst (100%) rename {docs => doc/source}/binaries.rst (100%) rename {docs => doc/source}/compute.rst (100%) rename {docs => doc/source}/conf.py (95%) rename {docs => doc/source}/endpoint.rst (100%) rename {docs => doc/source}/fakes.rst (100%) rename {docs => doc/source}/getting.started.rst (100%) rename {docs => doc/source}/index.rst (99%) rename {docs => doc/source}/modules.rst (100%) rename {docs => doc/source}/network.rst (100%) rename {docs => doc/source}/nova.rst (100%) rename {docs => doc/source}/objectstore.rst (100%) rename {docs => doc/source}/packages.rst (100%) rename {docs => doc/source}/storage.rst (100%) rename {docs => doc/source}/volume.rst (100%) diff --git a/docs/.gitignore b/doc/.gitignore similarity index 100% rename from docs/.gitignore rename to doc/.gitignore diff --git a/docs/_build/.gitignore b/doc/build/.gitignore similarity index 100% rename from docs/_build/.gitignore rename to doc/build/.gitignore diff --git a/docs/Makefile b/doc/source/Makefile similarity index 100% rename from docs/Makefile rename to doc/source/Makefile diff --git a/docs/_static/.gitignore b/doc/source/_static/.gitignore similarity index 100% rename from docs/_static/.gitignore rename to doc/source/_static/.gitignore diff --git a/docs/_templates/.gitignore b/doc/source/_templates/.gitignore similarity index 100% rename from docs/_templates/.gitignore rename to doc/source/_templates/.gitignore diff --git a/docs/architecture.rst b/doc/source/architecture.rst similarity index 100% rename from docs/architecture.rst rename to doc/source/architecture.rst diff --git a/docs/auth.rst b/doc/source/auth.rst similarity index 100% rename from docs/auth.rst rename to doc/source/auth.rst diff --git a/docs/binaries.rst b/doc/source/binaries.rst similarity index 100% rename from docs/binaries.rst rename to doc/source/binaries.rst diff --git a/docs/compute.rst b/doc/source/compute.rst similarity index 100% rename from docs/compute.rst rename to doc/source/compute.rst diff --git a/docs/conf.py b/doc/source/conf.py similarity index 95% rename from docs/conf.py rename to 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 similarity index 100% rename from docs/endpoint.rst rename to doc/source/endpoint.rst diff --git a/docs/fakes.rst b/doc/source/fakes.rst similarity index 100% rename from docs/fakes.rst rename to doc/source/fakes.rst diff --git a/docs/getting.started.rst b/doc/source/getting.started.rst similarity index 100% rename from docs/getting.started.rst rename to doc/source/getting.started.rst diff --git a/docs/index.rst b/doc/source/index.rst similarity index 99% rename from docs/index.rst rename to 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 similarity index 100% rename from docs/modules.rst rename to doc/source/modules.rst diff --git a/docs/network.rst b/doc/source/network.rst similarity index 100% rename from docs/network.rst rename to doc/source/network.rst diff --git a/docs/nova.rst b/doc/source/nova.rst similarity index 100% rename from docs/nova.rst rename to doc/source/nova.rst diff --git a/docs/objectstore.rst b/doc/source/objectstore.rst similarity index 100% rename from docs/objectstore.rst rename to doc/source/objectstore.rst diff --git a/docs/packages.rst b/doc/source/packages.rst similarity index 100% rename from docs/packages.rst rename to doc/source/packages.rst diff --git a/docs/storage.rst b/doc/source/storage.rst similarity index 100% rename from docs/storage.rst rename to doc/source/storage.rst diff --git a/docs/volume.rst b/doc/source/volume.rst similarity index 100% rename from docs/volume.rst rename to doc/source/volume.rst 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