diff options
author | Clark Boylan <clark.boylan@gmail.com> | 2012-06-08 15:41:05 -0700 |
---|---|---|
committer | Clark Boylan <clark.boylan@gmail.com> | 2012-06-11 13:33:02 -0700 |
commit | 3ba77383238d463c903eb5c9ae0da9879fd700e0 (patch) | |
tree | 3707b2cd4b3e7363d8461f37bca5b0be7f0f454a | |
parent | f2c87f68cf4adfff43df4989578e662446f37cd5 (diff) | |
download | python-keystoneclient-3ba77383238d463c903eb5c9ae0da9879fd700e0.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/source and build results go in project/doc/build.
Change-Id: I205e8bb1ddf6dae1d7392b32975319c6a6d98673
-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/conf.py (renamed from docs/conf.py) | 4 | ||||
-rw-r--r-- | doc/source/index.rst (renamed from docs/index.rst) | 0 | ||||
-rw-r--r-- | doc/source/ref/client.rst (renamed from docs/ref/client.rst) | 0 | ||||
-rw-r--r-- | doc/source/ref/endpoints.rst (renamed from docs/ref/endpoints.rst) | 0 | ||||
-rw-r--r-- | doc/source/ref/exceptions.rst (renamed from docs/ref/exceptions.rst) | 0 | ||||
-rw-r--r-- | doc/source/ref/generic-client.rst (renamed from docs/ref/generic-client.rst) | 0 | ||||
-rw-r--r-- | doc/source/ref/index.rst (renamed from docs/ref/index.rst) | 0 | ||||
-rw-r--r-- | doc/source/ref/roles.rst (renamed from docs/ref/roles.rst) | 0 | ||||
-rw-r--r-- | doc/source/ref/services.rst (renamed from docs/ref/services.rst) | 0 | ||||
-rw-r--r-- | doc/source/ref/tenants.rst (renamed from docs/ref/tenants.rst) | 0 | ||||
-rw-r--r-- | doc/source/ref/users.rst (renamed from docs/ref/users.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-- | doc/source/using-api.rst (renamed from docs/using-api.rst) | 0 | ||||
-rw-r--r-- | docs/.gitignore | 1 | ||||
-rw-r--r-- | setup.cfg | 6 |
19 files changed, 10 insertions, 9 deletions
diff --git a/MANIFEST.in b/MANIFEST.in index 8d65859..d70fbea 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 0000000..567609b --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/docs/Makefile b/doc/Makefile index 56f0ded..430e5a3 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 index cfaf189..15112e7 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 index bece0aa..bece0aa 100644 --- a/docs/index.rst +++ b/doc/source/index.rst diff --git a/docs/ref/client.rst b/doc/source/ref/client.rst index cb21e3e..cb21e3e 100644 --- a/docs/ref/client.rst +++ b/doc/source/ref/client.rst diff --git a/docs/ref/endpoints.rst b/doc/source/ref/endpoints.rst index ed2b4e2..ed2b4e2 100644 --- a/docs/ref/endpoints.rst +++ b/doc/source/ref/endpoints.rst diff --git a/docs/ref/exceptions.rst b/doc/source/ref/exceptions.rst index 988f7d0..988f7d0 100644 --- a/docs/ref/exceptions.rst +++ b/doc/source/ref/exceptions.rst diff --git a/docs/ref/generic-client.rst b/doc/source/ref/generic-client.rst index 9905558..9905558 100644 --- a/docs/ref/generic-client.rst +++ b/doc/source/ref/generic-client.rst diff --git a/docs/ref/index.rst b/doc/source/ref/index.rst index d99127e..d99127e 100644 --- a/docs/ref/index.rst +++ b/doc/source/ref/index.rst diff --git a/docs/ref/roles.rst b/doc/source/ref/roles.rst index 9cb9283..9cb9283 100644 --- a/docs/ref/roles.rst +++ b/doc/source/ref/roles.rst diff --git a/docs/ref/services.rst b/doc/source/ref/services.rst index a4b677c..a4b677c 100644 --- a/docs/ref/services.rst +++ b/doc/source/ref/services.rst diff --git a/docs/ref/tenants.rst b/doc/source/ref/tenants.rst index d6e3861..d6e3861 100644 --- a/docs/ref/tenants.rst +++ b/doc/source/ref/tenants.rst diff --git a/docs/ref/users.rst b/doc/source/ref/users.rst index 953daec..953daec 100644 --- a/docs/ref/users.rst +++ b/doc/source/ref/users.rst diff --git a/docs/releases.rst b/doc/source/releases.rst index 4a9d281..4a9d281 100644 --- a/docs/releases.rst +++ b/doc/source/releases.rst diff --git a/docs/shell.rst b/doc/source/shell.rst index c44d6b3..c44d6b3 100644 --- a/docs/shell.rst +++ b/doc/source/shell.rst diff --git a/docs/using-api.rst b/doc/source/using-api.rst index d8fa0bc..d8fa0bc 100644 --- a/docs/using-api.rst +++ b/doc/source/using-api.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 @@ -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 |