summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDolph Mathews <dolph.mathews@rackspace.com>2011-06-14 15:08:28 -0500
committerDolph Mathews <dolph.mathews@rackspace.com>2011-06-14 15:08:28 -0500
commit488670dd3815bb4c8a15eea0ebb2eb6e0d77f953 (patch)
treedf2216775f8f1c8f2639bf80dcce1c5f780f24da
parent72e4edcc12f4741bd945adf777fe43f3ffcd62d6 (diff)
parent7ccf7c589cef5a6a0b02801fc2147879fabce098 (diff)
downloadkeystone-488670dd3815bb4c8a15eea0ebb2eb6e0d77f953.tar.gz
keystone-488670dd3815bb4c8a15eea0ebb2eb6e0d77f953.tar.xz
keystone-488670dd3815bb4c8a15eea0ebb2eb6e0d77f953.zip
Merge branch 'master' of git://github.com/rackspace/keystone
-rw-r--r--.gitignore2
-rw-r--r--MANIFEST.in5
-rw-r--r--doc/Makefile96
-rw-r--r--doc/design/flow_diagram.pdf (renamed from docs/design/flow_diagram.pdf)0
-rw-r--r--doc/design/flow_diagram.png (renamed from docs/design/flow_diagram.png)bin163556 -> 163556 bytes
-rw-r--r--doc/design/flow_diagram.sdx (renamed from docs/design/flow_diagram.sdx)0
-rw-r--r--doc/guide/pom.xml (renamed from docs/guide/pom.xml)0
-rw-r--r--doc/guide/src/docbkx/identity.wadl (renamed from docs/guide/src/docbkx/identity.wadl)0
-rwxr-xr-xdoc/guide/src/docbkx/identitydevguide.xml (renamed from docs/guide/src/docbkx/identitydevguide.xml)0
-rw-r--r--doc/guide/src/docbkx/img/Check_mark_23x20_02.svg (renamed from docs/guide/src/docbkx/img/Check_mark_23x20_02.svg)0
-rw-r--r--doc/guide/src/docbkx/samples/auth.json (renamed from docs/guide/src/docbkx/samples/auth.json)0
-rw-r--r--doc/guide/src/docbkx/samples/auth.xml (renamed from docs/guide/src/docbkx/samples/auth.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/auth_credentials.json (renamed from docs/guide/src/docbkx/samples/auth_credentials.json)0
-rw-r--r--doc/guide/src/docbkx/samples/auth_credentials.xml (renamed from docs/guide/src/docbkx/samples/auth_credentials.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/baseURL.json (renamed from docs/guide/src/docbkx/samples/baseURL.json)0
-rw-r--r--doc/guide/src/docbkx/samples/baseURL.xml (renamed from docs/guide/src/docbkx/samples/baseURL.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/baseURLRef.json (renamed from docs/guide/src/docbkx/samples/baseURLRef.json)0
-rw-r--r--doc/guide/src/docbkx/samples/baseURLRef.xml (renamed from docs/guide/src/docbkx/samples/baseURLRef.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/baseURLRefs.json (renamed from docs/guide/src/docbkx/samples/baseURLRefs.json)0
-rw-r--r--doc/guide/src/docbkx/samples/baseURLRefs.xml (renamed from docs/guide/src/docbkx/samples/baseURLRefs.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/baseURLs.json (renamed from docs/guide/src/docbkx/samples/baseURLs.json)0
-rw-r--r--doc/guide/src/docbkx/samples/baseURLs.xml (renamed from docs/guide/src/docbkx/samples/baseURLs.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/choices.json (renamed from docs/guide/src/docbkx/samples/choices.json)0
-rw-r--r--doc/guide/src/docbkx/samples/choices.xml (renamed from docs/guide/src/docbkx/samples/choices.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/ext-getuser.json (renamed from docs/guide/src/docbkx/samples/ext-getuser.json)0
-rw-r--r--doc/guide/src/docbkx/samples/ext-getuser.xml (renamed from docs/guide/src/docbkx/samples/ext-getuser.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/extension.json (renamed from docs/guide/src/docbkx/samples/extension.json)0
-rw-r--r--doc/guide/src/docbkx/samples/extension.xml (renamed from docs/guide/src/docbkx/samples/extension.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/extensions.json (renamed from docs/guide/src/docbkx/samples/extensions.json)0
-rw-r--r--doc/guide/src/docbkx/samples/extensions.xml (renamed from docs/guide/src/docbkx/samples/extensions.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/getuser-1.json (renamed from docs/guide/src/docbkx/samples/getuser-1.json)0
-rw-r--r--doc/guide/src/docbkx/samples/getuser-1.xml (renamed from docs/guide/src/docbkx/samples/getuser-1.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/group.json (renamed from docs/guide/src/docbkx/samples/group.json)0
-rw-r--r--doc/guide/src/docbkx/samples/group.xml (renamed from docs/guide/src/docbkx/samples/group.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/groups.json (renamed from docs/guide/src/docbkx/samples/groups.json)0
-rw-r--r--doc/guide/src/docbkx/samples/groups.xml (renamed from docs/guide/src/docbkx/samples/groups.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/identity_fault.json (renamed from docs/guide/src/docbkx/samples/identity_fault.json)0
-rw-r--r--doc/guide/src/docbkx/samples/identity_fault.xml (renamed from docs/guide/src/docbkx/samples/identity_fault.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/item_not_found.json (renamed from docs/guide/src/docbkx/samples/item_not_found.json)0
-rw-r--r--doc/guide/src/docbkx/samples/item_not_found.xml (renamed from docs/guide/src/docbkx/samples/item_not_found.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/role.json (renamed from docs/guide/src/docbkx/samples/role.json)0
-rw-r--r--doc/guide/src/docbkx/samples/role.xml (renamed from docs/guide/src/docbkx/samples/role.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/roleRef.json (renamed from docs/guide/src/docbkx/samples/roleRef.json)0
-rw-r--r--doc/guide/src/docbkx/samples/roleRef.xml (renamed from docs/guide/src/docbkx/samples/roleRef.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/roleRefs.json (renamed from docs/guide/src/docbkx/samples/roleRefs.json)0
-rw-r--r--doc/guide/src/docbkx/samples/roleRefs.xml (renamed from docs/guide/src/docbkx/samples/roleRefs.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/roles.json (renamed from docs/guide/src/docbkx/samples/roles.json)0
-rw-r--r--doc/guide/src/docbkx/samples/roles.xml (renamed from docs/guide/src/docbkx/samples/roles.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/samplerequestheader.json (renamed from docs/guide/src/docbkx/samples/samplerequestheader.json)0
-rw-r--r--doc/guide/src/docbkx/samples/sampleresponseheader.json (renamed from docs/guide/src/docbkx/samples/sampleresponseheader.json)0
-rw-r--r--doc/guide/src/docbkx/samples/tenant.json (renamed from docs/guide/src/docbkx/samples/tenant.json)0
-rw-r--r--doc/guide/src/docbkx/samples/tenant.xml (renamed from docs/guide/src/docbkx/samples/tenant.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/tenantlock.json (renamed from docs/guide/src/docbkx/samples/tenantlock.json)0
-rw-r--r--doc/guide/src/docbkx/samples/tenantlock.xml (renamed from docs/guide/src/docbkx/samples/tenantlock.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/tenants-1.json (renamed from docs/guide/src/docbkx/samples/tenants-1.json)0
-rw-r--r--doc/guide/src/docbkx/samples/tenants-1.xml (renamed from docs/guide/src/docbkx/samples/tenants-1.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/tenants-2.json (renamed from docs/guide/src/docbkx/samples/tenants-2.json)0
-rw-r--r--doc/guide/src/docbkx/samples/tenants-2.xml (renamed from docs/guide/src/docbkx/samples/tenants-2.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/tenants-3.json (renamed from docs/guide/src/docbkx/samples/tenants-3.json)0
-rw-r--r--doc/guide/src/docbkx/samples/tenants-3.xml (renamed from docs/guide/src/docbkx/samples/tenants-3.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/tenants-request.txt (renamed from docs/guide/src/docbkx/samples/tenants-request.txt)0
-rw-r--r--doc/guide/src/docbkx/samples/tenants.json (renamed from docs/guide/src/docbkx/samples/tenants.json)0
-rw-r--r--doc/guide/src/docbkx/samples/tenants.xml (renamed from docs/guide/src/docbkx/samples/tenants.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/updatedtenant.json (renamed from docs/guide/src/docbkx/samples/updatedtenant.json)0
-rw-r--r--doc/guide/src/docbkx/samples/updatedtenant.xml (renamed from docs/guide/src/docbkx/samples/updatedtenant.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/validatetoken.json (renamed from docs/guide/src/docbkx/samples/validatetoken.json)0
-rw-r--r--doc/guide/src/docbkx/samples/validatetoken.xml (renamed from docs/guide/src/docbkx/samples/validatetoken.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/version-atom.xml (renamed from docs/guide/src/docbkx/samples/version-atom.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/version.json (renamed from docs/guide/src/docbkx/samples/version.json)0
-rw-r--r--doc/guide/src/docbkx/samples/version.xml (renamed from docs/guide/src/docbkx/samples/version.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/versions-atom.xml (renamed from docs/guide/src/docbkx/samples/versions-atom.xml)0
-rw-r--r--doc/guide/src/docbkx/samples/versions.json (renamed from docs/guide/src/docbkx/samples/versions.json)0
-rw-r--r--doc/guide/src/docbkx/samples/versions.xml (renamed from docs/guide/src/docbkx/samples/versions.xml)0
-rw-r--r--doc/guide/src/docbkx/xsd/api-common.xsd (renamed from docs/guide/src/docbkx/xsd/api-common.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/api.xsd (renamed from docs/guide/src/docbkx/xsd/api.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/atom/atom.xsd (renamed from docs/guide/src/docbkx/xsd/atom/atom.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/atom/xml.xsd (renamed from docs/guide/src/docbkx/xsd/atom/xml.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/baseURLs.xsd (renamed from docs/guide/src/docbkx/xsd/baseURLs.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/extensions.xsd (renamed from docs/guide/src/docbkx/xsd/extensions.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/fault.xsd (renamed from docs/guide/src/docbkx/xsd/fault.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/roles.xsd (renamed from docs/guide/src/docbkx/xsd/roles.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/tenant.xsd (renamed from docs/guide/src/docbkx/xsd/tenant.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/token.xsd (renamed from docs/guide/src/docbkx/xsd/token.xsd)0
-rw-r--r--doc/guide/src/docbkx/xsd/version.xsd (renamed from docs/guide/src/docbkx/xsd/version.xsd)0
-rw-r--r--doc/source/_static/basic.css416
-rw-r--r--doc/source/_static/default.css230
-rw-r--r--doc/source/_static/jquery.tweet.js154
-rw-r--r--doc/source/_static/tweaks.css65
-rw-r--r--doc/source/_templates/.placeholder0
-rw-r--r--doc/source/_theme/layout.html86
-rw-r--r--doc/source/_theme/theme.conf5
-rw-r--r--doc/source/architecture.rst19
-rw-r--r--doc/source/community.rst34
-rw-r--r--doc/source/conf.py246
-rw-r--r--doc/source/gettingstarted.rst23
-rw-r--r--doc/source/groups.rst19
-rw-r--r--doc/source/index.rst62
-rw-r--r--doc/source/installing.rst100
-rw-r--r--doc/source/man/keystonemanage.rst54
-rw-r--r--doc/source/roles.rst19
-rw-r--r--doc/source/tenants.rst19
-rw-r--r--doc/source/users.rst19
-rw-r--r--setup.py20
103 files changed, 1693 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index a96b8a80..f03b2768 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,5 @@ keystone.db
*.pid
pidfile
*.komodoproject
+docs/build/
+build/
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 00000000..f365e6b0
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,5 @@
+include README.md
+include MANIFEST.in
+graft doc
+graft etc
+graft tools
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 00000000..b63e3003
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,96 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SPHINXSOURCE = source
+PAPER =
+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) $(SPHINXSOURCE)
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+.DEFAULT_GOAL = html
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+ if [ -f .autogenerated ] ; then \
+ cat .autogenerated | xargs rm ; \
+ rm .autogenerated ; \
+ fi
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nova.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nova.qhc"
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/design/flow_diagram.pdf b/doc/design/flow_diagram.pdf
index 256086d6..256086d6 100644
--- a/docs/design/flow_diagram.pdf
+++ b/doc/design/flow_diagram.pdf
diff --git a/docs/design/flow_diagram.png b/doc/design/flow_diagram.png
index 88faf8d9..88faf8d9 100644
--- a/docs/design/flow_diagram.png
+++ b/doc/design/flow_diagram.png
Binary files differ
diff --git a/docs/design/flow_diagram.sdx b/doc/design/flow_diagram.sdx
index 68cccef8..68cccef8 100644
--- a/docs/design/flow_diagram.sdx
+++ b/doc/design/flow_diagram.sdx
diff --git a/docs/guide/pom.xml b/doc/guide/pom.xml
index fd16d6a3..fd16d6a3 100644
--- a/docs/guide/pom.xml
+++ b/doc/guide/pom.xml
diff --git a/docs/guide/src/docbkx/identity.wadl b/doc/guide/src/docbkx/identity.wadl
index 4b68f9a7..4b68f9a7 100644
--- a/docs/guide/src/docbkx/identity.wadl
+++ b/doc/guide/src/docbkx/identity.wadl
diff --git a/docs/guide/src/docbkx/identitydevguide.xml b/doc/guide/src/docbkx/identitydevguide.xml
index 97023c67..97023c67 100755
--- a/docs/guide/src/docbkx/identitydevguide.xml
+++ b/doc/guide/src/docbkx/identitydevguide.xml
diff --git a/docs/guide/src/docbkx/img/Check_mark_23x20_02.svg b/doc/guide/src/docbkx/img/Check_mark_23x20_02.svg
index 3051a2f9..3051a2f9 100644
--- a/docs/guide/src/docbkx/img/Check_mark_23x20_02.svg
+++ b/doc/guide/src/docbkx/img/Check_mark_23x20_02.svg
diff --git a/docs/guide/src/docbkx/samples/auth.json b/doc/guide/src/docbkx/samples/auth.json
index b5fbada2..b5fbada2 100644
--- a/docs/guide/src/docbkx/samples/auth.json
+++ b/doc/guide/src/docbkx/samples/auth.json
diff --git a/docs/guide/src/docbkx/samples/auth.xml b/doc/guide/src/docbkx/samples/auth.xml
index 6d90c064..6d90c064 100644
--- a/docs/guide/src/docbkx/samples/auth.xml
+++ b/doc/guide/src/docbkx/samples/auth.xml
diff --git a/docs/guide/src/docbkx/samples/auth_credentials.json b/doc/guide/src/docbkx/samples/auth_credentials.json
index 67b06304..67b06304 100644
--- a/docs/guide/src/docbkx/samples/auth_credentials.json
+++ b/doc/guide/src/docbkx/samples/auth_credentials.json
diff --git a/docs/guide/src/docbkx/samples/auth_credentials.xml b/doc/guide/src/docbkx/samples/auth_credentials.xml
index 56bd91d6..56bd91d6 100644
--- a/docs/guide/src/docbkx/samples/auth_credentials.xml
+++ b/doc/guide/src/docbkx/samples/auth_credentials.xml
diff --git a/docs/guide/src/docbkx/samples/baseURL.json b/doc/guide/src/docbkx/samples/baseURL.json
index 534484aa..534484aa 100644
--- a/docs/guide/src/docbkx/samples/baseURL.json
+++ b/doc/guide/src/docbkx/samples/baseURL.json
diff --git a/docs/guide/src/docbkx/samples/baseURL.xml b/doc/guide/src/docbkx/samples/baseURL.xml
index a66d5516..a66d5516 100644
--- a/docs/guide/src/docbkx/samples/baseURL.xml
+++ b/doc/guide/src/docbkx/samples/baseURL.xml
diff --git a/docs/guide/src/docbkx/samples/baseURLRef.json b/doc/guide/src/docbkx/samples/baseURLRef.json
index aed01500..aed01500 100644
--- a/docs/guide/src/docbkx/samples/baseURLRef.json
+++ b/doc/guide/src/docbkx/samples/baseURLRef.json
diff --git a/docs/guide/src/docbkx/samples/baseURLRef.xml b/doc/guide/src/docbkx/samples/baseURLRef.xml
index 16c71870..16c71870 100644
--- a/docs/guide/src/docbkx/samples/baseURLRef.xml
+++ b/doc/guide/src/docbkx/samples/baseURLRef.xml
diff --git a/docs/guide/src/docbkx/samples/baseURLRefs.json b/doc/guide/src/docbkx/samples/baseURLRefs.json
index a815f2b9..a815f2b9 100644
--- a/docs/guide/src/docbkx/samples/baseURLRefs.json
+++ b/doc/guide/src/docbkx/samples/baseURLRefs.json
diff --git a/docs/guide/src/docbkx/samples/baseURLRefs.xml b/doc/guide/src/docbkx/samples/baseURLRefs.xml
index 0c095626..0c095626 100644
--- a/docs/guide/src/docbkx/samples/baseURLRefs.xml
+++ b/doc/guide/src/docbkx/samples/baseURLRefs.xml
diff --git a/docs/guide/src/docbkx/samples/baseURLs.json b/doc/guide/src/docbkx/samples/baseURLs.json
index 36ec4f6e..36ec4f6e 100644
--- a/docs/guide/src/docbkx/samples/baseURLs.json
+++ b/doc/guide/src/docbkx/samples/baseURLs.json
diff --git a/docs/guide/src/docbkx/samples/baseURLs.xml b/doc/guide/src/docbkx/samples/baseURLs.xml
index 9f829e9d..9f829e9d 100644
--- a/docs/guide/src/docbkx/samples/baseURLs.xml
+++ b/doc/guide/src/docbkx/samples/baseURLs.xml
diff --git a/docs/guide/src/docbkx/samples/choices.json b/doc/guide/src/docbkx/samples/choices.json
index 16ec35f0..16ec35f0 100644
--- a/docs/guide/src/docbkx/samples/choices.json
+++ b/doc/guide/src/docbkx/samples/choices.json
diff --git a/docs/guide/src/docbkx/samples/choices.xml b/doc/guide/src/docbkx/samples/choices.xml
index 134c9d00..134c9d00 100644
--- a/docs/guide/src/docbkx/samples/choices.xml
+++ b/doc/guide/src/docbkx/samples/choices.xml
diff --git a/docs/guide/src/docbkx/samples/ext-getuser.json b/doc/guide/src/docbkx/samples/ext-getuser.json
index 03f74dda..03f74dda 100644
--- a/docs/guide/src/docbkx/samples/ext-getuser.json
+++ b/doc/guide/src/docbkx/samples/ext-getuser.json
diff --git a/docs/guide/src/docbkx/samples/ext-getuser.xml b/doc/guide/src/docbkx/samples/ext-getuser.xml
index bf0a9c6e..bf0a9c6e 100644
--- a/docs/guide/src/docbkx/samples/ext-getuser.xml
+++ b/doc/guide/src/docbkx/samples/ext-getuser.xml
diff --git a/docs/guide/src/docbkx/samples/extension.json b/doc/guide/src/docbkx/samples/extension.json
index 9efaa422..9efaa422 100644
--- a/docs/guide/src/docbkx/samples/extension.json
+++ b/doc/guide/src/docbkx/samples/extension.json
diff --git a/docs/guide/src/docbkx/samples/extension.xml b/doc/guide/src/docbkx/samples/extension.xml
index 056d7e96..056d7e96 100644
--- a/docs/guide/src/docbkx/samples/extension.xml
+++ b/doc/guide/src/docbkx/samples/extension.xml
diff --git a/docs/guide/src/docbkx/samples/extensions.json b/doc/guide/src/docbkx/samples/extensions.json
index da3cbc50..da3cbc50 100644
--- a/docs/guide/src/docbkx/samples/extensions.json
+++ b/doc/guide/src/docbkx/samples/extensions.json
diff --git a/docs/guide/src/docbkx/samples/extensions.xml b/doc/guide/src/docbkx/samples/extensions.xml
index c11b06d7..c11b06d7 100644
--- a/docs/guide/src/docbkx/samples/extensions.xml
+++ b/doc/guide/src/docbkx/samples/extensions.xml
diff --git a/docs/guide/src/docbkx/samples/getuser-1.json b/doc/guide/src/docbkx/samples/getuser-1.json
index bef6c9a7..bef6c9a7 100644
--- a/docs/guide/src/docbkx/samples/getuser-1.json
+++ b/doc/guide/src/docbkx/samples/getuser-1.json
diff --git a/docs/guide/src/docbkx/samples/getuser-1.xml b/doc/guide/src/docbkx/samples/getuser-1.xml
index cc0f5fc6..cc0f5fc6 100644
--- a/docs/guide/src/docbkx/samples/getuser-1.xml
+++ b/doc/guide/src/docbkx/samples/getuser-1.xml
diff --git a/docs/guide/src/docbkx/samples/group.json b/doc/guide/src/docbkx/samples/group.json
index 07dc0a10..07dc0a10 100644
--- a/docs/guide/src/docbkx/samples/group.json
+++ b/doc/guide/src/docbkx/samples/group.json
diff --git a/docs/guide/src/docbkx/samples/group.xml b/doc/guide/src/docbkx/samples/group.xml
index 0f285307..0f285307 100644
--- a/docs/guide/src/docbkx/samples/group.xml
+++ b/doc/guide/src/docbkx/samples/group.xml
diff --git a/docs/guide/src/docbkx/samples/groups.json b/doc/guide/src/docbkx/samples/groups.json
index 06dd58a0..06dd58a0 100644
--- a/docs/guide/src/docbkx/samples/groups.json
+++ b/doc/guide/src/docbkx/samples/groups.json
diff --git a/docs/guide/src/docbkx/samples/groups.xml b/doc/guide/src/docbkx/samples/groups.xml
index a429fdb3..a429fdb3 100644
--- a/docs/guide/src/docbkx/samples/groups.xml
+++ b/doc/guide/src/docbkx/samples/groups.xml
diff --git a/docs/guide/src/docbkx/samples/identity_fault.json b/doc/guide/src/docbkx/samples/identity_fault.json
index d61feff4..d61feff4 100644
--- a/docs/guide/src/docbkx/samples/identity_fault.json
+++ b/doc/guide/src/docbkx/samples/identity_fault.json
diff --git a/docs/guide/src/docbkx/samples/identity_fault.xml b/doc/guide/src/docbkx/samples/identity_fault.xml
index 6787af21..6787af21 100644
--- a/docs/guide/src/docbkx/samples/identity_fault.xml
+++ b/doc/guide/src/docbkx/samples/identity_fault.xml
diff --git a/docs/guide/src/docbkx/samples/item_not_found.json b/doc/guide/src/docbkx/samples/item_not_found.json
index dda88a59..dda88a59 100644
--- a/docs/guide/src/docbkx/samples/item_not_found.json
+++ b/doc/guide/src/docbkx/samples/item_not_found.json
diff --git a/docs/guide/src/docbkx/samples/item_not_found.xml b/doc/guide/src/docbkx/samples/item_not_found.xml
index 3f78b498..3f78b498 100644
--- a/docs/guide/src/docbkx/samples/item_not_found.xml
+++ b/doc/guide/src/docbkx/samples/item_not_found.xml
diff --git a/docs/guide/src/docbkx/samples/role.json b/doc/guide/src/docbkx/samples/role.json
index 904801ee..904801ee 100644
--- a/docs/guide/src/docbkx/samples/role.json
+++ b/doc/guide/src/docbkx/samples/role.json
diff --git a/docs/guide/src/docbkx/samples/role.xml b/doc/guide/src/docbkx/samples/role.xml
index 48fe20d8..48fe20d8 100644
--- a/docs/guide/src/docbkx/samples/role.xml
+++ b/doc/guide/src/docbkx/samples/role.xml
diff --git a/docs/guide/src/docbkx/samples/roleRef.json b/doc/guide/src/docbkx/samples/roleRef.json
index 83f4ae4b..83f4ae4b 100644
--- a/docs/guide/src/docbkx/samples/roleRef.json
+++ b/doc/guide/src/docbkx/samples/roleRef.json
diff --git a/docs/guide/src/docbkx/samples/roleRef.xml b/doc/guide/src/docbkx/samples/roleRef.xml
index 29115ee2..29115ee2 100644
--- a/docs/guide/src/docbkx/samples/roleRef.xml
+++ b/doc/guide/src/docbkx/samples/roleRef.xml
diff --git a/docs/guide/src/docbkx/samples/roleRefs.json b/doc/guide/src/docbkx/samples/roleRefs.json
index 51573f74..51573f74 100644
--- a/docs/guide/src/docbkx/samples/roleRefs.json
+++ b/doc/guide/src/docbkx/samples/roleRefs.json
diff --git a/docs/guide/src/docbkx/samples/roleRefs.xml b/doc/guide/src/docbkx/samples/roleRefs.xml
index bd7ee983..bd7ee983 100644
--- a/docs/guide/src/docbkx/samples/roleRefs.xml
+++ b/doc/guide/src/docbkx/samples/roleRefs.xml
diff --git a/docs/guide/src/docbkx/samples/roles.json b/doc/guide/src/docbkx/samples/roles.json
index 4f431806..4f431806 100644
--- a/docs/guide/src/docbkx/samples/roles.json
+++ b/doc/guide/src/docbkx/samples/roles.json
diff --git a/docs/guide/src/docbkx/samples/roles.xml b/doc/guide/src/docbkx/samples/roles.xml
index bf128ff4..bf128ff4 100644
--- a/docs/guide/src/docbkx/samples/roles.xml
+++ b/doc/guide/src/docbkx/samples/roles.xml
diff --git a/docs/guide/src/docbkx/samples/samplerequestheader.json b/doc/guide/src/docbkx/samples/samplerequestheader.json
index 5641d874..5641d874 100644
--- a/docs/guide/src/docbkx/samples/samplerequestheader.json
+++ b/doc/guide/src/docbkx/samples/samplerequestheader.json
diff --git a/docs/guide/src/docbkx/samples/sampleresponseheader.json b/doc/guide/src/docbkx/samples/sampleresponseheader.json
index aee1205a..aee1205a 100644
--- a/docs/guide/src/docbkx/samples/sampleresponseheader.json
+++ b/doc/guide/src/docbkx/samples/sampleresponseheader.json
diff --git a/docs/guide/src/docbkx/samples/tenant.json b/doc/guide/src/docbkx/samples/tenant.json
index 7ff7ce32..7ff7ce32 100644
--- a/docs/guide/src/docbkx/samples/tenant.json
+++ b/doc/guide/src/docbkx/samples/tenant.json
diff --git a/docs/guide/src/docbkx/samples/tenant.xml b/doc/guide/src/docbkx/samples/tenant.xml
index 83210f87..83210f87 100644
--- a/docs/guide/src/docbkx/samples/tenant.xml
+++ b/doc/guide/src/docbkx/samples/tenant.xml
diff --git a/docs/guide/src/docbkx/samples/tenantlock.json b/doc/guide/src/docbkx/samples/tenantlock.json
index 584c21a4..584c21a4 100644
--- a/docs/guide/src/docbkx/samples/tenantlock.json
+++ b/doc/guide/src/docbkx/samples/tenantlock.json
diff --git a/docs/guide/src/docbkx/samples/tenantlock.xml b/doc/guide/src/docbkx/samples/tenantlock.xml
index 06a68a83..06a68a83 100644
--- a/docs/guide/src/docbkx/samples/tenantlock.xml
+++ b/doc/guide/src/docbkx/samples/tenantlock.xml
diff --git a/docs/guide/src/docbkx/samples/tenants-1.json b/doc/guide/src/docbkx/samples/tenants-1.json
index c80050a4..c80050a4 100644
--- a/docs/guide/src/docbkx/samples/tenants-1.json
+++ b/doc/guide/src/docbkx/samples/tenants-1.json
diff --git a/docs/guide/src/docbkx/samples/tenants-1.xml b/doc/guide/src/docbkx/samples/tenants-1.xml
index 18fcbfd3..18fcbfd3 100644
--- a/docs/guide/src/docbkx/samples/tenants-1.xml
+++ b/doc/guide/src/docbkx/samples/tenants-1.xml
diff --git a/docs/guide/src/docbkx/samples/tenants-2.json b/doc/guide/src/docbkx/samples/tenants-2.json
index d1fcae35..d1fcae35 100644
--- a/docs/guide/src/docbkx/samples/tenants-2.json
+++ b/doc/guide/src/docbkx/samples/tenants-2.json
diff --git a/docs/guide/src/docbkx/samples/tenants-2.xml b/doc/guide/src/docbkx/samples/tenants-2.xml
index 4ad53477..4ad53477 100644
--- a/docs/guide/src/docbkx/samples/tenants-2.xml
+++ b/doc/guide/src/docbkx/samples/tenants-2.xml
diff --git a/docs/guide/src/docbkx/samples/tenants-3.json b/doc/guide/src/docbkx/samples/tenants-3.json
index 72948804..72948804 100644
--- a/docs/guide/src/docbkx/samples/tenants-3.json
+++ b/doc/guide/src/docbkx/samples/tenants-3.json
diff --git a/docs/guide/src/docbkx/samples/tenants-3.xml b/doc/guide/src/docbkx/samples/tenants-3.xml
index 7bbd88a7..7bbd88a7 100644
--- a/docs/guide/src/docbkx/samples/tenants-3.xml
+++ b/doc/guide/src/docbkx/samples/tenants-3.xml
diff --git a/docs/guide/src/docbkx/samples/tenants-request.txt b/doc/guide/src/docbkx/samples/tenants-request.txt
index 9dbf85e5..9dbf85e5 100644
--- a/docs/guide/src/docbkx/samples/tenants-request.txt
+++ b/doc/guide/src/docbkx/samples/tenants-request.txt
diff --git a/docs/guide/src/docbkx/samples/tenants.json b/doc/guide/src/docbkx/samples/tenants.json
index a2fa2608..a2fa2608 100644
--- a/docs/guide/src/docbkx/samples/tenants.json
+++ b/doc/guide/src/docbkx/samples/tenants.json
diff --git a/docs/guide/src/docbkx/samples/tenants.xml b/doc/guide/src/docbkx/samples/tenants.xml
index 2a9e9c3b..2a9e9c3b 100644
--- a/docs/guide/src/docbkx/samples/tenants.xml
+++ b/doc/guide/src/docbkx/samples/tenants.xml
diff --git a/docs/guide/src/docbkx/samples/updatedtenant.json b/doc/guide/src/docbkx/samples/updatedtenant.json
index 05df6a3a..05df6a3a 100644
--- a/docs/guide/src/docbkx/samples/updatedtenant.json
+++ b/doc/guide/src/docbkx/samples/updatedtenant.json
diff --git a/docs/guide/src/docbkx/samples/updatedtenant.xml b/doc/guide/src/docbkx/samples/updatedtenant.xml
index 51999a4d..51999a4d 100644
--- a/docs/guide/src/docbkx/samples/updatedtenant.xml
+++ b/doc/guide/src/docbkx/samples/updatedtenant.xml
diff --git a/docs/guide/src/docbkx/samples/validatetoken.json b/doc/guide/src/docbkx/samples/validatetoken.json
index 6906991a..6906991a 100644
--- a/docs/guide/src/docbkx/samples/validatetoken.json
+++ b/doc/guide/src/docbkx/samples/validatetoken.json
diff --git a/docs/guide/src/docbkx/samples/validatetoken.xml b/doc/guide/src/docbkx/samples/validatetoken.xml
index af40a8b6..af40a8b6 100644
--- a/docs/guide/src/docbkx/samples/validatetoken.xml
+++ b/doc/guide/src/docbkx/samples/validatetoken.xml
diff --git a/docs/guide/src/docbkx/samples/version-atom.xml b/doc/guide/src/docbkx/samples/version-atom.xml
index 004a5444..004a5444 100644
--- a/docs/guide/src/docbkx/samples/version-atom.xml
+++ b/doc/guide/src/docbkx/samples/version-atom.xml
diff --git a/docs/guide/src/docbkx/samples/version.json b/doc/guide/src/docbkx/samples/version.json
index fce09386..fce09386 100644
--- a/docs/guide/src/docbkx/samples/version.json
+++ b/doc/guide/src/docbkx/samples/version.json
diff --git a/docs/guide/src/docbkx/samples/version.xml b/doc/guide/src/docbkx/samples/version.xml
index 0e884504..0e884504 100644
--- a/docs/guide/src/docbkx/samples/version.xml
+++ b/doc/guide/src/docbkx/samples/version.xml
diff --git a/docs/guide/src/docbkx/samples/versions-atom.xml b/doc/guide/src/docbkx/samples/versions-atom.xml
index 67783e8e..67783e8e 100644
--- a/docs/guide/src/docbkx/samples/versions-atom.xml
+++ b/doc/guide/src/docbkx/samples/versions-atom.xml
diff --git a/docs/guide/src/docbkx/samples/versions.json b/doc/guide/src/docbkx/samples/versions.json
index ec3a8498..ec3a8498 100644
--- a/docs/guide/src/docbkx/samples/versions.json
+++ b/doc/guide/src/docbkx/samples/versions.json
diff --git a/docs/guide/src/docbkx/samples/versions.xml b/doc/guide/src/docbkx/samples/versions.xml
index df55b106..df55b106 100644
--- a/docs/guide/src/docbkx/samples/versions.xml
+++ b/doc/guide/src/docbkx/samples/versions.xml
diff --git a/docs/guide/src/docbkx/xsd/api-common.xsd b/doc/guide/src/docbkx/xsd/api-common.xsd
index 5e8ebeda..5e8ebeda 100644
--- a/docs/guide/src/docbkx/xsd/api-common.xsd
+++ b/doc/guide/src/docbkx/xsd/api-common.xsd
diff --git a/docs/guide/src/docbkx/xsd/api.xsd b/doc/guide/src/docbkx/xsd/api.xsd
index a23abd99..a23abd99 100644
--- a/docs/guide/src/docbkx/xsd/api.xsd
+++ b/doc/guide/src/docbkx/xsd/api.xsd
diff --git a/docs/guide/src/docbkx/xsd/atom/atom.xsd b/doc/guide/src/docbkx/xsd/atom/atom.xsd
index c515c497..c515c497 100644
--- a/docs/guide/src/docbkx/xsd/atom/atom.xsd
+++ b/doc/guide/src/docbkx/xsd/atom/atom.xsd
diff --git a/docs/guide/src/docbkx/xsd/atom/xml.xsd b/doc/guide/src/docbkx/xsd/atom/xml.xsd
index aea7d0db..aea7d0db 100644
--- a/docs/guide/src/docbkx/xsd/atom/xml.xsd
+++ b/doc/guide/src/docbkx/xsd/atom/xml.xsd
diff --git a/docs/guide/src/docbkx/xsd/baseURLs.xsd b/doc/guide/src/docbkx/xsd/baseURLs.xsd
index 54869140..54869140 100644
--- a/docs/guide/src/docbkx/xsd/baseURLs.xsd
+++ b/doc/guide/src/docbkx/xsd/baseURLs.xsd
diff --git a/docs/guide/src/docbkx/xsd/extensions.xsd b/doc/guide/src/docbkx/xsd/extensions.xsd
index a942f0a1..a942f0a1 100644
--- a/docs/guide/src/docbkx/xsd/extensions.xsd
+++ b/doc/guide/src/docbkx/xsd/extensions.xsd
diff --git a/docs/guide/src/docbkx/xsd/fault.xsd b/doc/guide/src/docbkx/xsd/fault.xsd
index 6725e3a4..6725e3a4 100644
--- a/docs/guide/src/docbkx/xsd/fault.xsd
+++ b/doc/guide/src/docbkx/xsd/fault.xsd
diff --git a/docs/guide/src/docbkx/xsd/roles.xsd b/doc/guide/src/docbkx/xsd/roles.xsd
index 6f8cc207..6f8cc207 100644
--- a/docs/guide/src/docbkx/xsd/roles.xsd
+++ b/doc/guide/src/docbkx/xsd/roles.xsd
diff --git a/docs/guide/src/docbkx/xsd/tenant.xsd b/doc/guide/src/docbkx/xsd/tenant.xsd
index 26ef15fe..26ef15fe 100644
--- a/docs/guide/src/docbkx/xsd/tenant.xsd
+++ b/doc/guide/src/docbkx/xsd/tenant.xsd
diff --git a/docs/guide/src/docbkx/xsd/token.xsd b/doc/guide/src/docbkx/xsd/token.xsd
index 5e9aae46..5e9aae46 100644
--- a/docs/guide/src/docbkx/xsd/token.xsd
+++ b/doc/guide/src/docbkx/xsd/token.xsd
diff --git a/docs/guide/src/docbkx/xsd/version.xsd b/doc/guide/src/docbkx/xsd/version.xsd
index 6b2403bd..6b2403bd 100644
--- a/docs/guide/src/docbkx/xsd/version.xsd
+++ b/doc/guide/src/docbkx/xsd/version.xsd
diff --git a/doc/source/_static/basic.css b/doc/source/_static/basic.css
new file mode 100644
index 00000000..d909ce37
--- /dev/null
+++ b/doc/source/_static/basic.css
@@ -0,0 +1,416 @@
+/**
+ * Sphinx stylesheet -- basic theme
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 230px;
+ margin-left: -100%;
+ font-size: 90%;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+img {
+ border: 0;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li div.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable dl, table.indextable dd {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+a.headerlink {
+ visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.field-list ul {
+ padding-left: 1em;
+}
+
+.first {
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px 7px 0 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px 7px 0 7px;
+ margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+div.admonition dl {
+ margin-bottom: 0;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 0;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+table.footnote td, table.footnote th {
+ border: 0 !important;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+/* -- other body styles ----------------------------------------------------- */
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd p {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+dt:target, .highlight {
+ background-color: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.refcount {
+ color: #060;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+}
+
+td.linenos pre {
+ padding: 5px 0px;
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ margin-left: 0.5em;
+}
+
+table.highlighttable td {
+ padding: 0 0.5em 0 0.5em;
+}
+
+tt.descname {
+ background-color: transparent;
+ font-weight: bold;
+ font-size: 1.2em;
+}
+
+tt.descclassname {
+ background-color: transparent;
+}
+
+tt.xref, a tt {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
+ background-color: transparent;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
diff --git a/doc/source/_static/default.css b/doc/source/_static/default.css
new file mode 100644
index 00000000..c8091ecb
--- /dev/null
+++ b/doc/source/_static/default.css
@@ -0,0 +1,230 @@
+/**
+ * Sphinx stylesheet -- default theme
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ */
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: sans-serif;
+ font-size: 100%;
+ background-color: #11303d;
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+div.document {
+ background-color: #1c4e63;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 230px;
+}
+
+div.body {
+ background-color: #ffffff;
+ color: #000000;
+ padding: 0 20px 30px 20px;
+}
+
+div.footer {
+ color: #ffffff;
+ width: 100%;
+ padding: 9px 0 9px 0;
+ text-align: center;
+ font-size: 75%;
+}
+
+div.footer a {
+ color: #ffffff;
+ text-decoration: underline;
+}
+
+div.related {
+ background-color: #133f52;
+ line-height: 30px;
+ color: #ffffff;
+}
+
+div.related a {
+ color: #ffffff;
+}
+
+div.sphinxsidebar {
+}
+
+div.sphinxsidebar h3 {
+ font-family: 'Trebuchet MS', sans-serif;
+ color: #ffffff;
+ font-size: 1.4em;
+ font-weight: normal;
+ margin: 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h3 a {
+ color: #ffffff;
+}
+
+div.sphinxsidebar h4 {
+ font-family: 'Trebuchet MS', sans-serif;
+ color: #ffffff;
+ font-size: 1.3em;
+ font-weight: normal;
+ margin: 5px 0 0 0;
+ padding: 0;
+}
+
+div.sphinxsidebar p {
+ color: #ffffff;
+}
+
+div.sphinxsidebar p.topless {
+ margin: 5px 10px 10px 10px;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px;
+ padding: 0;
+ color: #ffffff;
+}
+
+div.sphinxsidebar a {
+ color: #98dbcc;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+ color: #355f7c;
+ text-decoration: none;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+div.body p, div.body dd, div.body li {
+ text-align: left;
+ line-height: 130%;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: 'Trebuchet MS', sans-serif;
+ background-color: #f2f2f2;
+ font-weight: normal;
+ color: #20435c;
+ border-bottom: 1px solid #ccc;
+ margin: 20px -20px 10px -20px;
+ padding: 3px 0 3px 10px;
+}
+
+div.body h1 { margin-top: 0; font-size: 200%; }
+div.body h2 { font-size: 160%; }
+div.body h3 { font-size: 140%; }
+div.body h4 { font-size: 120%; }
+div.body h5 { font-size: 110%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: #c60f0f;
+ font-size: 0.8em;
+ padding: 0 4px 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ background-color: #c60f0f;
+ color: white;
+}
+
+div.body p, div.body dd, div.body li {
+ text-align: left;
+ line-height: 130%;
+}
+
+div.admonition p.admonition-title + p {
+ display: inline;
+}
+
+div.admonition p {
+ margin-bottom: 5px;
+}
+
+div.admonition pre {
+ margin-bottom: 5px;
+}
+
+div.admonition ul, div.admonition ol {
+ margin-bottom: 5px;
+}
+
+div.note {
+ background-color: #eee;
+ border: 1px solid #ccc;
+}
+
+div.seealso {
+ background-color: #ffc;
+ border: 1px solid #ff6;
+}
+
+div.topic {
+ background-color: #eee;
+}
+
+div.warning {
+ background-color: #ffe4e4;
+ border: 1px solid #f66;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre {
+ padding: 5px;
+ background-color: #eeffcc;
+ color: #333333;
+ line-height: 120%;
+ border: 1px solid #ac9;
+ border-left: none;
+ border-right: none;
+}
+
+tt {
+ background-color: #ecf0f3;
+ padding: 0 1px 0 1px;
+ font-size: 0.95em;
+}
+
+.warning tt {
+ background: #efc2c2;
+}
+
+.note tt {
+ background: #d6d6d6;
+}
diff --git a/doc/source/_static/jquery.tweet.js b/doc/source/_static/jquery.tweet.js
new file mode 100644
index 00000000..c93fea87
--- /dev/null
+++ b/doc/source/_static/jquery.tweet.js
@@ -0,0 +1,154 @@
+(function($) {
+
+ $.fn.tweet = function(o){
+ var s = {
+ username: ["seaofclouds"], // [string] required, unless you want to display our tweets. :) it can be an array, just do ["username1","username2","etc"]
+ list: null, //[string] optional name of list belonging to username
+ avatar_size: null, // [integer] height and width of avatar if displayed (48px max)
+ count: 3, // [integer] how many tweets to display?
+ intro_text: null, // [string] do you want text BEFORE your your tweets?
+ outro_text: null, // [string] do you want text AFTER your tweets?
+ join_text: null, // [string] optional text in between date and tweet, try setting to "auto"
+ auto_join_text_default: "i said,", // [string] auto text for non verb: "i said" bullocks
+ auto_join_text_ed: "i", // [string] auto text for past tense: "i" surfed
+ auto_join_text_ing: "i am", // [string] auto tense for present tense: "i was" surfing
+ auto_join_text_reply: "i replied to", // [string] auto tense for replies: "i replied to" @someone "with"
+ auto_join_text_url: "i was looking at", // [string] auto tense for urls: "i was looking at" http:...
+ loading_text: null, // [string] optional loading text, displayed while tweets load
+ query: null // [string] optional search query
+ };
+
+ if(o) $.extend(s, o);
+
+ $.fn.extend({
+ linkUrl: function() {
+ var returning = [];
+ var regexp = /((ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?)/gi;
+ this.each(function() {
+ returning.push(this.replace(regexp,"<a href=\"$1\">$1</a>"));
+ });
+ return $(returning);
+ },
+ linkUser: function() {
+ var returning = [];
+ var regexp = /[\@]+([A-Za-z0-9-_]+)/gi;
+ this.each(function() {
+ returning.push(this.replace(regexp,"<a href=\"http://twitter.com/$1\">@$1</a>"));
+ });
+ return $(returning);
+ },
+ linkHash: function() {
+ var returning = [];
+ var regexp = / [\#]+([A-Za-z0-9-_]+)/gi;
+ this.each(function() {
+ returning.push(this.replace(regexp, ' <a href="http://search.twitter.com/search?q=&tag=$1&lang=all&from='+s.username.join("%2BOR%2B")+'">#$1</a>'));
+ });
+ return $(returning);
+ },
+ capAwesome: function() {
+ var returning = [];
+ this.each(function() {
+ returning.push(this.replace(/\b(awesome)\b/gi, '<span class="awesome">$1</span>'));
+ });
+ return $(returning);
+ },
+ capEpic: function() {
+ var returning = [];
+ this.each(function() {
+ returning.push(this.replace(/\b(epic)\b/gi, '<span class="epic">$1</span>'));
+ });
+ return $(returning);
+ },
+ makeHeart: function() {
+ var returning = [];
+ this.each(function() {
+ returning.push(this.replace(/(&lt;)+[3]/gi, "<tt class='heart'>&#x2665;</tt>"));
+ });
+ return $(returning);
+ }
+ });
+
+ function relative_time(time_value) {
+ var parsed_date = Date.parse(time_value);
+ var relative_to = (arguments.length > 1) ? arguments[1] : new Date();
+ var delta = parseInt((relative_to.getTime() - parsed_date) / 1000);
+ var pluralize = function (singular, n) {
+ return '' + n + ' ' + singular + (n == 1 ? '' : 's');
+ };
+ if(delta < 60) {
+ return 'less than a minute ago';
+ } else if(delta < (45*60)) {
+ return 'about ' + pluralize("minute", parseInt(delta / 60)) + ' ago';
+ } else if(delta < (24*60*60)) {
+ return 'about ' + pluralize("hour", parseInt(delta / 3600)) + ' ago';
+ } else {
+ return 'about ' + pluralize("day", parseInt(delta / 86400)) + ' ago';
+ }
+ }
+
+ function build_url() {
+ var proto = ('https:' == document.location.protocol ? 'https:' : 'http:');
+ if (s.list) {
+ return proto+"//api.twitter.com/1/"+s.username[0]+"/lists/"+s.list+"/statuses.json?per_page="+s.count+"&callback=?";
+ } else if (s.query == null && s.username.length == 1) {
+ return proto+'//twitter.com/status/user_timeline/'+s.username[0]+'.json?count='+s.count+'&callback=?';
+ } else {
+ var query = (s.query || 'from:'+s.username.join('%20OR%20from:'));
+ return proto+'//search.twitter.com/search.json?&q='+query+'&rpp='+s.count+'&callback=?';
+ }
+ }
+
+ return this.each(function(){
+ var list = $('<ul class="tweet_list">').appendTo(this);
+ var intro = '<p class="tweet_intro">'+s.intro_text+'</p>';
+ var outro = '<p class="tweet_outro">'+s.outro_text+'</p>';
+ var loading = $('<p class="loading">'+s.loading_text+'</p>');
+
+ if(typeof(s.username) == "string"){
+ s.username = [s.username];
+ }
+
+ if (s.loading_text) $(this).append(loading);
+ $.getJSON(build_url(), function(data){
+ if (s.loading_text) loading.remove();
+ if (s.intro_text) list.before(intro);
+ $.each((data.results || data), function(i,item){
+ // auto join text based on verb tense and content
+ if (s.join_text == "auto") {
+ if (item.text.match(/^(@([A-Za-z0-9-_]+)) .*/i)) {
+ var join_text = s.auto_join_text_reply;
+ } else if (item.text.match(/(^\w+:\/\/[A-Za-z0-9-_]+\.[A-Za-z0-9-_:%&\?\/.=]+) .*/i)) {
+ var join_text = s.auto_join_text_url;
+ } else if (item.text.match(/^((\w+ed)|just) .*/im)) {
+ var join_text = s.auto_join_text_ed;
+ } else if (item.text.match(/^(\w*ing) .*/i)) {
+ var join_text = s.auto_join_text_ing;
+ } else {
+ var join_text = s.auto_join_text_default;
+ }
+ } else {
+ var join_text = s.join_text;
+ };
+
+ var from_user = item.from_user || item.user.screen_name;
+ var profile_image_url = item.profile_image_url || item.user.profile_image_url;
+ var join_template = '<span class="tweet_join"> '+join_text+' </span>';
+ var join = ((s.join_text) ? join_template : ' ');
+ var avatar_template = '<a class="tweet_avatar" href="http://twitter.com/'+from_user+'"><img src="'+profile_image_url+'" height="'+s.avatar_size+'" width="'+s.avatar_size+'" alt="'+from_user+'\'s avatar" title="'+from_user+'\'s avatar" border="0"/></a>';
+ var avatar = (s.avatar_size ? avatar_template : '');
+ var date = '<a href="http://twitter.com/'+from_user+'/statuses/'+item.id+'" title="view tweet on twitter">'+relative_time(item.created_at)+'</a>';
+ var text = '<span class="tweet_text">' +$([item.text]).linkUrl().linkUser().linkHash().makeHeart().capAwesome().capEpic()[0]+ '</span>';
+
+ // until we create a template option, arrange the items below to alter a tweet's display.
+ list.append('<li>' + avatar + date + join + text + '</li>');
+
+ list.children('li:first').addClass('tweet_first');
+ list.children('li:odd').addClass('tweet_even');
+ list.children('li:even').addClass('tweet_odd');
+ });
+ if (s.outro_text) list.after(outro);
+ });
+
+ });
+ };
+})(jQuery); \ No newline at end of file
diff --git a/doc/source/_static/tweaks.css b/doc/source/_static/tweaks.css
new file mode 100644
index 00000000..16cd6e76
--- /dev/null
+++ b/doc/source/_static/tweaks.css
@@ -0,0 +1,65 @@
+ul.todo_list {
+ list-style-type: none;
+ margin: 0;
+ padding: 0;
+}
+
+ul.todo_list li {
+ display: block;
+ margin: 0;
+ padding: 7px 0;
+ border-top: 1px solid #eee;
+}
+
+ul.todo_list li p {
+ display: inline;
+}
+
+ul.todo_list li p.link {
+ font-weight: bold;
+}
+
+ul.todo_list li p.details {
+ font-style: italic;
+}
+
+ul.todo_list li {
+}
+
+div.admonition {
+ border: 1px solid #8F1000;
+}
+
+div.admonition p.admonition-title {
+ background-color: #8F1000;
+ border-bottom: 1px solid #8E8E8E;
+}
+
+a {
+ color: #CF2F19;
+}
+
+div.related ul li a {
+ color: #CF2F19;
+}
+
+div.sphinxsidebar h4 {
+ background-color:#8E8E8E;
+ border:1px solid #255E6E;
+ color:white;
+ font-size:1em;
+ margin:1em 0 0.5em;
+ padding:0.1em 0 0.1em 0.5em;
+}
+
+em {
+ font-style: normal;
+}
+
+table.docutils {
+ font-size: 11px;
+}
+
+a tt {
+ color:#CF2F19;
+} \ No newline at end of file
diff --git a/doc/source/_templates/.placeholder b/doc/source/_templates/.placeholder
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/doc/source/_templates/.placeholder
diff --git a/doc/source/_theme/layout.html b/doc/source/_theme/layout.html
new file mode 100644
index 00000000..e3eb54b7
--- /dev/null
+++ b/doc/source/_theme/layout.html
@@ -0,0 +1,86 @@
+{% extends "sphinxdoc/layout.html" %}
+{% set css_files = css_files + ['_static/tweaks.css'] %}
+{% set script_files = script_files + ['_static/jquery.tweet.js'] %}
+{% block extrahead %}
+ <script type='text/javascript'>
+ $(document).ready(function(){
+ $("#twitter_feed").tweet({
+ username: "openstack",
+ query: "from:openstack",
+ avatar_size: 32,
+ count: 10,
+ loading_text: "loading tweets..."
+ });
+ });
+ </script>
+{% endblock %}
+
+{%- macro sidebar() %}
+ {%- if not embedded %}{% if not theme_nosidebar|tobool %}
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ {%- block sidebarlogo %}
+ {%- if logo %}
+ <p class="logo"><a href="{{ pathto(master_doc) }}">
+ <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
+ </a></p>
+ {%- endif %}
+ {%- endblock %}
+ {%- block sidebartoc %}
+ {%- if display_toc %}
+ <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
+ {{ toc }}
+ {%- endif %}
+ {%- endblock %}
+ {%- block sidebarrel %}
+ {%- if prev %}
+ <h4>{{ _('Previous topic') }}</h4>
+ <p class="topless"><a href="{{ prev.link|e }}"
+ title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>
+ {%- endif %}
+ {%- if next %}
+ <h4>{{ _('Next topic') }}</h4>
+ <p class="topless"><a href="{{ next.link|e }}"
+ title="{{ _('next chapter') }}">{{ next.title }}</a></p>
+ {%- endif %}
+ {%- endblock %}
+ {%- block sidebarsourcelink %}
+ {%- if show_source and has_source and sourcename %}
+ <h3>{{ _('This Page') }}</h3>
+ <ul class="this-page-menu">
+ <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
+ rel="nofollow">{{ _('Show Source') }}</a></li>
+ </ul>
+ {%- endif %}
+ {%- endblock %}
+ {%- if customsidebar %}
+ {% include customsidebar %}
+ {%- endif %}
+ {%- block sidebarsearch %}
+ {%- if pagename != "search" %}
+ <div id="searchbox" style="display: none">
+ <h3>{{ _('Quick search') }}</h3>
+ <form class="search" action="{{ pathto('search') }}" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="{{ _('Go') }}" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ {{ _('Enter search terms or a module, class or function name.') }}
+ </p>
+ </div>
+ <script type="text/javascript">$('#searchbox').show(0);</script>
+ {%- endif %}
+
+ {%- if pagename == "index" %}
+ <h3>{{ _('Twitter Feed') }}</h3>
+ <div id="twitter_feed" class='twitter_feed'></div>
+ {%- endif %}
+
+
+ {%- endblock %}
+ </div>
+ </div>
+ {%- endif %}{% endif %}
+{%- endmacro %}
diff --git a/doc/source/_theme/theme.conf b/doc/source/_theme/theme.conf
new file mode 100644
index 00000000..e039fe01
--- /dev/null
+++ b/doc/source/_theme/theme.conf
@@ -0,0 +1,5 @@
+[theme]
+inherit = sphinxdoc
+stylesheet = sphinxdoc.css
+pygments_style = friendly
+
diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst
new file mode 100644
index 00000000..102202c7
--- /dev/null
+++ b/doc/source/architecture.rst
@@ -0,0 +1,19 @@
+..
+ Copyright 2011 OpenStack, LLC
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Keystone Architecture
+=====================
+
diff --git a/doc/source/community.rst b/doc/source/community.rst
new file mode 100644
index 00000000..419a5951
--- /dev/null
+++ b/doc/source/community.rst
@@ -0,0 +1,34 @@
+..
+ Copyright 2011 OpenStack, LLC
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Getting Involved
+================
+
+The Keystone community is a very friendly group and there are places online to join in with the
+community. Feel free to ask questions. This document points you to some of the places where you can
+communicate with people.
+
+How to Join the Keystone Community
+----------------------------------
+
+Our community welcomes all people interested in open source cloud computing, and there are no formal
+membership requirements. The best way to join the community is to talk with others online or at a meetup
+and offer contributions through Launchpad, the wiki, or blogs. We welcome all types of contributions,
+from blueprint designs to documentation to testing to deployment scripts.
+
+Contributing Code
+-----------------
+
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100644
index 00000000..0fa9eb44
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,246 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2010 OpenStack, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#
+# Keystone documentation build configuration file, created by
+# sphinx-quickstart on Tue May 18 13:50:15 2010.
+#
+# This file is execfile()'d with the current directory set to it's containing
+# dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import os
+import sys
+
+# 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
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.append([os.path.abspath('../keystone'),
+ os.path.abspath('..'),
+ os.path.abspath('../bin')
+ ])
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.ifconfig',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.pngmath',
+ 'sphinx.ext.graphviz',
+ 'sphinx.ext.todo']
+
+todo_include_todos = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = []
+if os.getenv('HUDSON_PUBLISH_DOCS'):
+ templates_path = ['_ga', '_templates']
+else:
+ templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Keystone'
+copyright = u'2011-present, OpenStack, LLC.'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+from keystone import version as keystone_version
+# The full version, including alpha/beta/rc tags.
+release = keystone_version
+# The short X.Y version.
+version = keystone_version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# The reST default role (for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+show_authors = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+modindex_common_prefix = ['keystone.']
+
+# -- Options for man page output --------------------------------------------
+
+# Grouping the document tree for man pages.
+# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
+
+man_pages = [
+ ('man/keystonemanage', 'keystone-manage', u'Keystone Management Utility',
+ [u'OpenStack'], 1)
+ ]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme_path = ["."]
+html_theme = '_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = ['_theme']
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'keystonedoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author,
+# documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'Keystone.tex', u'Keystone Documentation',
+ u'Keystone Team', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'python': ('http://docs.python.org/', None),
+ 'nova': ('http://nova.openstack.org', None),
+ 'swift': ('http://swift.openstack.org', None),
+ 'glance': ('http://glance.openstack.org', None)}
diff --git a/doc/source/gettingstarted.rst b/doc/source/gettingstarted.rst
new file mode 100644
index 00000000..f83ad0d8
--- /dev/null
+++ b/doc/source/gettingstarted.rst
@@ -0,0 +1,23 @@
+..
+ Copyright 2011 OpenStack, LLC
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Quick Guide to Getting Started with Keystone
+============================================
+
+
+Overview of Keystone Architecture
+---------------------------------
+
diff --git a/doc/source/groups.rst b/doc/source/groups.rst
new file mode 100644
index 00000000..59703e05
--- /dev/null
+++ b/doc/source/groups.rst
@@ -0,0 +1,19 @@
+..
+ Copyright 2011 OpenStack, LLC
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Groups
+======
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 00000000..52023688
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,62 @@
+..
+ Copyright 2011 OpenStack, LLC
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Welcome to Keystone's documentation!
+====================================
+
+The Keystone project provides services for authenticating and managing
+user, account, and role information.
+
+Concepts
+========
+
+.. toctree::
+ :maxdepth: 1
+
+ users
+ tenants
+ groups
+ roles
+
+Using Keystone
+==============
+
+.. toctree::
+ :maxdepth: 1
+
+ gettingstarted
+ installing
+
+Developer Docs
+==============
+
+.. toctree::
+ :maxdepth: 1
+
+ architecture
+ community
+
+Outstanding Documentation Tasks
+===============================
+
+.. todolist::
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/doc/source/installing.rst b/doc/source/installing.rst
new file mode 100644
index 00000000..cc88b1fb
--- /dev/null
+++ b/doc/source/installing.rst
@@ -0,0 +1,100 @@
+..
+ Copyright 2011 OpenStack, LLC
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Installing Keystone
+===================
+
+Installing from packages
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+To install the latest version of Keystone from the Launchpad Bazaar repositories,
+following the following instructions.
+
+Debian/Ubuntu
+#############
+
+1. Add the Keystone PPA to your sources.lst::
+
+ $> sudo add-apt-repository ppa:keystone-core/trunk
+ $> sudo apt-get update
+
+2. Install Keystone::
+
+ $> sudo apt-get install keystone
+
+RedHat/Fedora
+#############
+
+.. todo:: Need some help on this one...
+
+Mac OSX
+#######
+
+.. todo:: No idea how to do install on Mac OSX. Somebody with a Mac should complete this section
+
+Installing from source tarballs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To install the latest version of Keystone from the Launchpad Bazaar repositories,
+following the following instructions.
+
+1. Grab the source tarball from `Launchpad <http://launchpad.net/keystone/+download>`_
+
+2. Untar the source tarball::
+
+ $> tar -xzf <FILE>
+
+3. Change into the package directory and build/install::
+
+ $> cd keystone-<RELEASE>
+ $> sudo python setup.py install
+
+Installing from a Bazaar Branch
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To install the latest version of Keystone from the Launchpad Bazaar repositories,
+following the following instructions.
+
+Debian/Ubuntu
+#############
+
+1. Install Bazaar and build dependencies::
+
+ $> sudo apt-get install bzr python-eventlet python-routes python-greenlet swift
+ $> sudo apt-get install python-argparse python-sqlalchemy python-wsgiref python-pastedeploy
+
+.. note::
+
+ If you want to build the Keystone documentation locally, you will also want
+ to install the python-sphinx package
+
+1. Branch Keystone's trunk branch::
+
+ $> bzr branch lp:keystone
+
+1. Install Keystone::
+
+ $> sudo python setup.py install
+
+RedHat/Fedora
+#############
+
+.. todo:: Need some help on this one...
+
+Mac OSX
+#######
+
+.. todo:: No idea how to do install on Mac OSX. Somebody with a Mac should complete this section
diff --git a/doc/source/man/keystonemanage.rst b/doc/source/man/keystonemanage.rst
new file mode 100644
index 00000000..8960eea3
--- /dev/null
+++ b/doc/source/man/keystonemanage.rst
@@ -0,0 +1,54 @@
+===============
+keystone-manage
+===============
+
+---------------------------
+Keystone Management Utility
+---------------------------
+
+:Author: keystone@lists.launchpad.net
+:Date: 2010-11-16
+:Copyright: OpenStack LLC
+:Version: 0.1.2
+:Manual section: 1
+:Manual group: cloud computing
+
+SYNOPSIS
+========
+
+ keystone-manage [options]
+
+DESCRIPTION
+===========
+
+keystone-manage is a utility for managing and configuring a Keystone installation.
+One important use of keystone-manage is to setup the database. To do this run::
+
+ keystone-manage db_sync
+
+OPTIONS
+=======
+
+ **General options**
+
+ **-v, --verbose**
+ Print more verbose output
+
+ **--sql_connection=CONN_STRING**
+ A proper SQLAlchemy connection string as described
+ `here <http://www.sqlalchemy.org/docs/05/reference/sqlalchemy/connections.html?highlight=engine#sqlalchemy.create_engine>`_
+
+FILES
+=====
+
+None
+
+SEE ALSO
+========
+
+* `Keystone <http://github.com/rackspace/keystone>`__
+
+BUGS
+====
+
+* Keystone is sourced in GitHub so you can view current bugs at `Keystone <http://github.com/rackspace/keystone>`__
diff --git a/doc/source/roles.rst b/doc/source/roles.rst
new file mode 100644
index 00000000..bc55a1d0
--- /dev/null
+++ b/doc/source/roles.rst
@@ -0,0 +1,19 @@
+..
+ Copyright 2011 OpenStack, LLC
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Roles
+=====
+
diff --git a/doc/source/tenants.rst b/doc/source/tenants.rst
new file mode 100644
index 00000000..2fdbf8b4
--- /dev/null
+++ b/doc/source/tenants.rst
@@ -0,0 +1,19 @@
+..
+ Copyright 2011 OpenStack, LLC
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Tenants
+=======
+
diff --git a/doc/source/users.rst b/doc/source/users.rst
new file mode 100644
index 00000000..44f43eaa
--- /dev/null
+++ b/doc/source/users.rst
@@ -0,0 +1,19 @@
+..
+ Copyright 2011 OpenStack, LLC
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Users
+=====
+
diff --git a/setup.py b/setup.py
index 1ddf18eb..6e366ac6 100644
--- a/setup.py
+++ b/setup.py
@@ -18,6 +18,25 @@ from setuptools import setup, find_packages
version = '1.0'
+cmdclass = {}
+
+# If Sphinx is installed on the box running setup.py,
+# enable setup.py to build the documentation, otherwise,
+# just ignore it
+try:
+ from sphinx.setup_command import BuildDoc
+
+ class local_BuildDoc(BuildDoc):
+ def run(self):
+ for builder in ['html', 'man']:
+ self.builder = builder
+ self.finalize_options()
+ BuildDoc.run(self)
+ cmdclass['build_sphinx'] = local_BuildDoc
+
+except:
+ pass
+
setup(
name='keystone',
version=version,
@@ -33,6 +52,7 @@ setup(
scripts=['bin/keystone', 'bin/keystone-auth', 'bin/keystone-admin',
'bin/keystone-manage'],
zip_safe=False,
+ cmdclass=cmdclass,
install_requires=['setuptools'],
entry_points={
'paste.app_factory': ['main=identity:app_factory'],