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
openstack · Jun 11, 2012 · ebceca9 · ebceca9
1 parent d263f1f
commit ebceca9
Show file tree

Hide file tree

Showing 17 changed files with 9 additions and 8 deletions.
diff --git 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
@@ -0,0 +1 @@
+build/
diff --git a/docs/Makefile → doc/Makefile b/docs/Makefile → 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 → doc/source/api.rst b/docs/api.rst → doc/source/api.rst
diff --git a/docs/conf.py → doc/source/conf.py b/docs/conf.py → doc/source/conf.py
@@ -64,7 +64,7 @@
 
 # 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 → doc/source/index.rst b/docs/index.rst → doc/source/index.rst
diff --git a/docs/ref/backup_schedules.rst → doc/source/ref/backup_schedules.rst b/docs/ref/backup_schedules.rst → doc/source/ref/backup_schedules.rst
diff --git a/docs/ref/exceptions.rst → doc/source/ref/exceptions.rst b/docs/ref/exceptions.rst → doc/source/ref/exceptions.rst
diff --git a/docs/ref/flavors.rst → doc/source/ref/flavors.rst b/docs/ref/flavors.rst → doc/source/ref/flavors.rst
diff --git a/docs/ref/images.rst → doc/source/ref/images.rst b/docs/ref/images.rst → doc/source/ref/images.rst
diff --git a/docs/ref/index.rst → doc/source/ref/index.rst b/docs/ref/index.rst → doc/source/ref/index.rst
diff --git a/docs/ref/ipgroups.rst → doc/source/ref/ipgroups.rst b/docs/ref/ipgroups.rst → doc/source/ref/ipgroups.rst
diff --git a/docs/ref/servers.rst → doc/source/ref/servers.rst b/docs/ref/servers.rst → doc/source/ref/servers.rst
diff --git a/docs/releases.rst → doc/source/releases.rst b/docs/releases.rst → doc/source/releases.rst
diff --git a/docs/shell.rst → doc/source/shell.rst b/docs/shell.rst → doc/source/shell.rst
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git 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