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 and build results go in project/doc/build.

Change-Id: I3ae14ac735d9b4c0b534eac9a9c142f8ccaac1b9
This commit is contained in:
Clark Boylan 2012-06-08 15:14:06 -07:00 committed by Monty Taylor
parent 93f9fa75fa
commit 7547dadf87
17 changed files with 12 additions and 8 deletions

View File

@ -4,6 +4,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 *

1
doc/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
build/

View File

@ -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

View File

@ -17,6 +17,9 @@ import sys, os
# 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('.'))
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
sys.path.insert(0, ROOT)
# -- General configuration -----------------------------------------------------
@ -64,7 +67,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

1
docs/.gitignore vendored
View File

@ -1 +0,0 @@
_build/

View File

@ -7,9 +7,9 @@ verbosity=2
detailed-errors=1
[build_sphinx]
source-dir = docs/
build-dir = docs/_build
all_files = 1
source-dir = doc/source
build-dir = doc/build
[upload_sphinx]
upload-dir = docs/_build/html
upload-dir = doc/build/html