diff options
| author | Clark Boylan <clark.boylan@gmail.com> | 2012-06-08 15:14:06 -0700 |
|---|---|---|
| committer | Monty Taylor <mordred@inaugust.com> | 2012-06-15 16:28:14 -0400 |
| commit | 7547dadf8731bcdd166f8f59a427fc1caeda111f (patch) | |
| tree | 3773001a7301cf02dbbd420038e0de0a24c89b71 | |
| parent | 93f9fa75fa8b96e4429dce73e0320686b5b52893 (diff) | |
| download | python-cinderclient-7547dadf8731bcdd166f8f59a427fc1caeda111f.tar.gz | |
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
| -rw-r--r-- | MANIFEST.in | 2 | ||||
| -rw-r--r-- | doc/.gitignore | 1 | ||||
| -rw-r--r-- | doc/Makefile (renamed from docs/Makefile) | 5 | ||||
| -rw-r--r-- | doc/source/api.rst (renamed from docs/api.rst) | 0 | ||||
| -rw-r--r-- | doc/source/conf.py (renamed from docs/conf.py) | 5 | ||||
| -rw-r--r-- | doc/source/index.rst (renamed from docs/index.rst) | 0 | ||||
| -rw-r--r-- | doc/source/ref/backup_schedules.rst (renamed from docs/ref/backup_schedules.rst) | 0 | ||||
| -rw-r--r-- | doc/source/ref/exceptions.rst (renamed from docs/ref/exceptions.rst) | 0 | ||||
| -rw-r--r-- | doc/source/ref/flavors.rst (renamed from docs/ref/flavors.rst) | 0 | ||||
| -rw-r--r-- | doc/source/ref/images.rst (renamed from docs/ref/images.rst) | 0 | ||||
| -rw-r--r-- | doc/source/ref/index.rst (renamed from docs/ref/index.rst) | 0 | ||||
| -rw-r--r-- | doc/source/ref/ipgroups.rst (renamed from docs/ref/ipgroups.rst) | 0 | ||||
| -rw-r--r-- | doc/source/ref/servers.rst (renamed from docs/ref/servers.rst) | 0 | ||||
| -rw-r--r-- | doc/source/releases.rst (renamed from docs/releases.rst) | 0 | ||||
| -rw-r--r-- | doc/source/shell.rst (renamed from docs/shell.rst) | 0 | ||||
| -rw-r--r-- | docs/.gitignore | 1 | ||||
| -rw-r--r-- | setup.cfg | 6 |
17 files changed, 12 insertions, 8 deletions
diff --git a/MANIFEST.in b/MANIFEST.in index 546c113..6827754 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -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 * diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/docs/Makefile b/doc/Makefile index c00452a..f948ac9 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 index 1e184bb..1e184bb 100644 --- a/docs/api.rst +++ b/doc/source/api.rst diff --git a/docs/conf.py b/doc/source/conf.py index 575886f..ccbe64b 100644 --- a/docs/conf.py +++ b/doc/source/conf.py @@ -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 diff --git a/docs/index.rst b/doc/source/index.rst index d992f7c..d992f7c 100644 --- a/docs/index.rst +++ b/doc/source/index.rst diff --git a/docs/ref/backup_schedules.rst b/doc/source/ref/backup_schedules.rst index cbd69e3..cbd69e3 100644 --- a/docs/ref/backup_schedules.rst +++ b/doc/source/ref/backup_schedules.rst diff --git a/docs/ref/exceptions.rst b/doc/source/ref/exceptions.rst index 23618e3..23618e3 100644 --- a/docs/ref/exceptions.rst +++ b/doc/source/ref/exceptions.rst diff --git a/docs/ref/flavors.rst b/doc/source/ref/flavors.rst index 12b396a..12b396a 100644 --- a/docs/ref/flavors.rst +++ b/doc/source/ref/flavors.rst diff --git a/docs/ref/images.rst b/doc/source/ref/images.rst index 6ba6c24..6ba6c24 100644 --- a/docs/ref/images.rst +++ b/doc/source/ref/images.rst diff --git a/docs/ref/index.rst b/doc/source/ref/index.rst index c1fe136..c1fe136 100644 --- a/docs/ref/index.rst +++ b/doc/source/ref/index.rst diff --git a/docs/ref/ipgroups.rst b/doc/source/ref/ipgroups.rst index 4c29f2e..4c29f2e 100644 --- a/docs/ref/ipgroups.rst +++ b/doc/source/ref/ipgroups.rst diff --git a/docs/ref/servers.rst b/doc/source/ref/servers.rst index b02fca5..b02fca5 100644 --- a/docs/ref/servers.rst +++ b/doc/source/ref/servers.rst diff --git a/docs/releases.rst b/doc/source/releases.rst index 783b1ca..783b1ca 100644 --- a/docs/releases.rst +++ b/doc/source/releases.rst diff --git a/docs/shell.rst b/doc/source/shell.rst index cff5cc7..cff5cc7 100644 --- a/docs/shell.rst +++ b/doc/source/shell.rst diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index c6a151b..0000000 --- a/docs/.gitignore +++ /dev/null @@ -1 +0,0 @@ -_build/
\ No newline at end of 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 |
