← Back to branch summary

~rlane/nova/ldapimprovements

« back to all changes in this revision

Viewing changes to doc/source/conf.py

  • Committer: Ryan Lane
  • Date: 2010-11-24 15:46:32 UTC
  • mfrom: (382.48.1 trunk)
  • Revision ID: laner@controller-20101124154632-zh7kwjuyyd02a2lh
Merge from trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/conf.py
16
16
# If extensions (or modules to document with autodoc) are in another directory,
17
17
# add these directories to sys.path here. If the directory is relative to the
18
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
19
 
sys.path.append([os.path.abspath('../nova'), os.path.abspath('..'), os.path.abspath('../bin')])
20
 
 
 
19
sys.path.insert(0, os.path.abspath('../../'))
 
20
sys.path.insert(0, os.path.abspath('../'))
 
21
sys.path.insert(0, os.path.abspath('./'))
21
22
 
22
23
# -- General configuration -----------------------------------------------------
23
24
 
24
25
# Add any Sphinx extension module names here, as strings. They can be extensions
25
26
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
26
 
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
 
27
 
 
28
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'ext.nova_todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig','sphinx.ext.graphviz']
 
29
 
 
30
# autodoc generation is a bit aggressive and a nuisance when doing heavy text edit cycles.
 
31
# execute "export SPHINX_DEBUG=1" in your terminal to disable
 
32
if not os.getenv('SPHINX_DEBUG'):
 
33
    extensions += ['ext.nova_autodoc']
 
34
 
27
35
todo_include_todos = True
28
36
 
29
37
# Add any paths that contain templates here, relative to this directory.
30
 
templates_path = ['_templates']
 
38
# Changing the path so that the Hudson build output contains GA code and the source
 
39
# docs do not contain the code so local, offline sphinx builds are "clean."
 
40
templates_path = []
 
41
if os.getenv('HUDSON_PUBLISH_DOCS'):
 
42
  templates_path = ['_ga', '_templates']
 
43
else:
 
44
  templates_path = ['_templates']
31
45
 
32
46
# The suffix of source filenames.
33
47
source_suffix = '.rst'
47
61
# built documents.
48
62
#
49
63
# The short X.Y version.
50
 
version = '2010.1'
 
64
version = '2011.1'
51
65
# The full version, including alpha/beta/rc tags.
52
 
release = '2010.1'
 
66
release = '2011.1-prerelease'
53
67
 
54
68
# The language for content autogenerated by Sphinx. Refer to documentation
55
69
# for a list of supported languages.
88
102
# A list of ignored prefixes for module index sorting.
89
103
modindex_common_prefix = ['nova.']
90
104
 
 
105
# -- Options for man page output -----------------------------------------------
 
106
 
 
107
# Grouping the document tree for man pages. 
 
108
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
 
109
 
 
110
man_pages = [
 
111
    ('man/novamanage', 'novamanage', u'Cloud controller fabric',
 
112
     [u'OpenStack'], 1)
 
113
 ]
91
114
 
92
115
# -- Options for HTML output ---------------------------------------------------
93
116
 
94
117
# The theme to use for HTML and HTML Help pages.  Major themes that come with
95
118
# Sphinx are currently 'default' and 'sphinxdoc'.
96
 
html_theme = 'default'
 
119
html_theme_path = ["."]
 
120
html_theme = '_theme'
97
121
 
98
122
# Theme options are theme-specific and customize the look and feel of a theme
99
123
# further.  For a list of options available for each theme, see the