From 3ba77383238d463c903eb5c9ae0da9879fd700e0 Mon Sep 17 00:00:00 2001 From: Clark Boylan Date: Fri, 8 Jun 2012 15:41:05 -0700 Subject: [PATCH] Move docs to doc. To better facilitate the building and publishing of sphinx documentation by Jenkins we are moving all openstack projects with sphinx documentation to a common doc tree structure. Documentation goes in project/doc/source and build results go in project/doc/build. Change-Id: I205e8bb1ddf6dae1d7392b32975319c6a6d98673 --- MANIFEST.in | 2 +- doc/.gitignore | 1 + {docs => doc}/Makefile | 5 +++-- {docs => doc/source}/conf.py | 4 ++-- {docs => doc/source}/index.rst | 0 {docs => doc/source}/ref/client.rst | 0 {docs => doc/source}/ref/endpoints.rst | 0 {docs => doc/source}/ref/exceptions.rst | 0 {docs => doc/source}/ref/generic-client.rst | 0 {docs => doc/source}/ref/index.rst | 0 {docs => doc/source}/ref/roles.rst | 0 {docs => doc/source}/ref/services.rst | 0 {docs => doc/source}/ref/tenants.rst | 0 {docs => doc/source}/ref/users.rst | 0 {docs => doc/source}/releases.rst | 0 {docs => doc/source}/shell.rst | 0 {docs => doc/source}/using-api.rst | 0 docs/.gitignore | 1 - setup.cfg | 6 +++--- 19 files changed, 10 insertions(+), 9 deletions(-) create mode 100644 doc/.gitignore rename {docs => doc}/Makefile (97%) rename {docs => doc/source}/conf.py (99%) rename {docs => doc/source}/index.rst (100%) rename {docs => doc/source}/ref/client.rst (100%) rename {docs => doc/source}/ref/endpoints.rst (100%) rename {docs => doc/source}/ref/exceptions.rst (100%) rename {docs => doc/source}/ref/generic-client.rst (100%) rename {docs => doc/source}/ref/index.rst (100%) rename {docs => doc/source}/ref/roles.rst (100%) rename {docs => doc/source}/ref/services.rst (100%) rename {docs => doc/source}/ref/tenants.rst (100%) rename {docs => doc/source}/ref/users.rst (100%) rename {docs => doc/source}/releases.rst (100%) rename {docs => doc/source}/shell.rst (100%) rename {docs => doc/source}/using-api.rst (100%) delete mode 100644 docs/.gitignore diff --git a/MANIFEST.in b/MANIFEST.in index 8d65859c8..d70fbeab2 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,6 @@ include README.rst include AUTHORS HACKING LICENSE include run_tests.sh tox.ini -recursive-include docs * +recursive-include doc * recursive-include tests * recursive-include tools * diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 000000000..567609b12 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/docs/Makefile b/doc/Makefile similarity index 97% rename from docs/Makefile rename to doc/Makefile index 56f0ded83..430e5a33a 100644 --- a/docs/Makefile +++ b/doc/Makefile @@ -4,13 +4,14 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build +SPHINXSOURCE = source PAPER = -BUILDDIR = _build +BUILDDIR = build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINXSOURCE) .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest diff --git a/docs/conf.py b/doc/source/conf.py similarity index 99% rename from docs/conf.py rename to doc/source/conf.py index cfaf189af..15112e75e 100644 --- a/docs/conf.py +++ b/doc/source/conf.py @@ -13,7 +13,7 @@ import sys, os -sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))) +sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))) # 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 @@ -66,7 +66,7 @@ release = '2.7.0' # 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 diff --git a/docs/index.rst b/doc/source/index.rst similarity index 100% rename from docs/index.rst rename to doc/source/index.rst diff --git a/docs/ref/client.rst b/doc/source/ref/client.rst similarity index 100% rename from docs/ref/client.rst rename to doc/source/ref/client.rst diff --git a/docs/ref/endpoints.rst b/doc/source/ref/endpoints.rst similarity index 100% rename from docs/ref/endpoints.rst rename to doc/source/ref/endpoints.rst diff --git a/docs/ref/exceptions.rst b/doc/source/ref/exceptions.rst similarity index 100% rename from docs/ref/exceptions.rst rename to doc/source/ref/exceptions.rst diff --git a/docs/ref/generic-client.rst b/doc/source/ref/generic-client.rst similarity index 100% rename from docs/ref/generic-client.rst rename to doc/source/ref/generic-client.rst diff --git a/docs/ref/index.rst b/doc/source/ref/index.rst similarity index 100% rename from docs/ref/index.rst rename to doc/source/ref/index.rst diff --git a/docs/ref/roles.rst b/doc/source/ref/roles.rst similarity index 100% rename from docs/ref/roles.rst rename to doc/source/ref/roles.rst diff --git a/docs/ref/services.rst b/doc/source/ref/services.rst similarity index 100% rename from docs/ref/services.rst rename to doc/source/ref/services.rst diff --git a/docs/ref/tenants.rst b/doc/source/ref/tenants.rst similarity index 100% rename from docs/ref/tenants.rst rename to doc/source/ref/tenants.rst diff --git a/docs/ref/users.rst b/doc/source/ref/users.rst similarity index 100% rename from docs/ref/users.rst rename to doc/source/ref/users.rst diff --git a/docs/releases.rst b/doc/source/releases.rst similarity index 100% rename from docs/releases.rst rename to doc/source/releases.rst diff --git a/docs/shell.rst b/doc/source/shell.rst similarity index 100% rename from docs/shell.rst rename to doc/source/shell.rst diff --git a/docs/using-api.rst b/doc/source/using-api.rst similarity index 100% rename from docs/using-api.rst rename to doc/source/using-api.rst diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index c6a151b32..000000000 --- a/docs/.gitignore +++ /dev/null @@ -1 +0,0 @@ -_build/ \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index 778428301..925c4a372 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,9 +4,9 @@ cover-erase = true cover-inclusive = true [build_sphinx] -source-dir = docs/ -build-dir = docs/_build +source-dir = doc/source +build-dir = doc/build all_files = 1 [upload_sphinx] -upload-dir = docs/_build/html +upload-dir = doc/build/html