From ebceca94146b2ab004dfb88069ee3a6917b460ad Mon Sep 17 00:00:00 2001 From: Clark Boylan Date: Mon, 11 Jun 2012 14:13:55 -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: I868df12e3c15cc30043e782ce0a609b9574295cd --- MANIFEST.in | 2 +- doc/.gitignore | 1 + {docs => doc}/Makefile | 5 +++-- {docs => doc/source}/api.rst | 0 {docs => doc/source}/conf.py | 2 +- {docs => doc/source}/index.rst | 0 {docs => doc/source}/ref/backup_schedules.rst | 0 {docs => doc/source}/ref/exceptions.rst | 0 {docs => doc/source}/ref/flavors.rst | 0 {docs => doc/source}/ref/images.rst | 0 {docs => doc/source}/ref/index.rst | 0 {docs => doc/source}/ref/ipgroups.rst | 0 {docs => doc/source}/ref/servers.rst | 0 {docs => doc/source}/releases.rst | 0 {docs => doc/source}/shell.rst | 0 docs/.gitignore | 1 - setup.cfg | 6 +++--- 17 files changed, 9 insertions(+), 8 deletions(-) create mode 100644 doc/.gitignore rename {docs => doc}/Makefile (97%) rename {docs => doc/source}/api.rst (100%) rename {docs => doc/source}/conf.py (99%) rename {docs => doc/source}/index.rst (100%) rename {docs => doc/source}/ref/backup_schedules.rst (100%) rename {docs => doc/source}/ref/exceptions.rst (100%) rename {docs => doc/source}/ref/flavors.rst (100%) rename {docs => doc/source}/ref/images.rst (100%) rename {docs => doc/source}/ref/index.rst (100%) rename {docs => doc/source}/ref/ipgroups.rst (100%) rename {docs => doc/source}/ref/servers.rst (100%) rename {docs => doc/source}/releases.rst (100%) rename {docs => doc/source}/shell.rst (100%) delete mode 100644 docs/.gitignore diff --git a/MANIFEST.in b/MANIFEST.in index c217ce17c..936fd6c24 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,6 +3,6 @@ include HACKING include LICENSE include README.rst 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 948b6f712..73aeb6edf 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/api.rst b/doc/source/api.rst similarity index 100% rename from docs/api.rst rename to doc/source/api.rst 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 ade5b76f6..f6c6b5719 100644 --- a/docs/conf.py +++ b/doc/source/conf.py @@ -64,7 +64,7 @@ release = '2.6.10' # 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/backup_schedules.rst b/doc/source/ref/backup_schedules.rst similarity index 100% rename from docs/ref/backup_schedules.rst rename to doc/source/ref/backup_schedules.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/flavors.rst b/doc/source/ref/flavors.rst similarity index 100% rename from docs/ref/flavors.rst rename to doc/source/ref/flavors.rst diff --git a/docs/ref/images.rst b/doc/source/ref/images.rst similarity index 100% rename from docs/ref/images.rst rename to doc/source/ref/images.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/ipgroups.rst b/doc/source/ref/ipgroups.rst similarity index 100% rename from docs/ref/ipgroups.rst rename to doc/source/ref/ipgroups.rst diff --git a/docs/ref/servers.rst b/doc/source/ref/servers.rst similarity index 100% rename from docs/ref/servers.rst rename to doc/source/ref/servers.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/.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 3ab04be57..7fa3ddac5 100644 --- a/setup.cfg +++ b/setup.cfg @@ -7,9 +7,9 @@ verbosity=2 detailed-errors=1 [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