summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoe Heck <heckj@mac.com>2012-01-19 01:52:44 +0000
committerJoe Heck <heckj@mac.com>2012-01-19 16:47:00 -0800
commitffeb0e558ca1108df02c53c9170e73020e57e67c (patch)
tree4e36a7360d05b2d61565c038f1a53f524cb5c886 /docs
parent89c378c2400d697059b3e5d81f65814424604c05 (diff)
downloadkeystone-ffeb0e558ca1108df02c53c9170e73020e57e67c.tar.gz
keystone-ffeb0e558ca1108df02c53c9170e73020e57e67c.tar.xz
keystone-ffeb0e558ca1108df02c53c9170e73020e57e67c.zip
doctry
Diffstat (limited to 'docs')
-rw-r--r--docs/source/conf.py29
1 files changed, 22 insertions, 7 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 9c18c5ff..11c8adb0 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -11,7 +11,8 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os
+import sys
+import os
# 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
@@ -26,10 +27,19 @@ sys.path.insert(0, os.path.abspath('../..'))
# 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.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage']
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage']
+extensions = ['sphinx.ext.autodoc',
+ 'sphinx.ext.todo',
+# 'sphinx.ect.intersphinx',
+ 'sphinx.ext.coverage']
+
+todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = []
+if os.getenv('HUDSON_PUBLISH_DOCS'):
+ templates_path = ['_ga', '_templates']
+else:
+ templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@@ -79,20 +89,21 @@ exclude_patterns = []
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
-#show_authors = False
+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 = []
+modindex_common_prefix = ['keystone.']
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'default'
+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
@@ -121,7 +132,7 @@ html_theme = 'default'
# 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']
+html_static_path = ['_static', 'images']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
@@ -245,3 +256,7 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}
+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)}