~styluseater/swift/lp610583

« back to all changes in this revision

Viewing changes to doc/source/conf.py

  • Committer: Tarmac
  • Author(s): Monty Taylor
  • Date: 2010-07-25 01:45:27 UTC
  • mfrom: (39.1.1 align-openstack-sphinx)
  • Revision ID: hudson@openstack.org-20100725014527-86ly3l16d7jy64e5
Updated Sphinx config to match the config from Nova.

Show diffs side-by-side

added added

removed removed

Lines of Context:
31
31
# If extensions (or modules to document with autodoc) are in another directory,
32
32
# add these directories to sys.path here. If the directory is relative to the
33
33
# documentation root, use os.path.abspath to make it absolute, like shown here.
34
 
#sys.path.append(os.path.abspath('.'))
 
34
sys.path.append([os.path.abspath('../swift'), os.path.abspath('..'), os.path.abspath('../bin')])
35
35
 
36
36
# -- General configuration -----------------------------------------------------
37
37
 
38
38
# Add any Sphinx extension module names here, as strings. They can be extensions
39
39
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
40
 
extensions = ['sphinx.ext.autodoc']
 
40
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
 
41
todo_include_todos = True
41
42
 
42
43
# Add any paths that contain templates here, relative to this directory.
43
44
templates_path = ['_templates']
93
94
 
94
95
# If true, sectionauthor and moduleauthor directives will be shown in the
95
96
# output. They are ignored by default.
96
 
#show_authors = False
 
97
show_authors = True
97
98
 
98
99
# The name of the Pygments (syntax highlighting) style to use.
99
100
pygments_style = 'sphinx'
100
101
 
101
102
# A list of ignored prefixes for module index sorting.
102
 
#modindex_common_prefix = []
 
103
modindex_common_prefix = ['swift.']
103
104
 
104
105
 
105
106
# -- Options for HTML output ---------------------------------------------------
173
174
#html_file_suffix = ''
174
175
 
175
176
# Output file base name for HTML help builder.
176
 
htmlhelp_basename = 'Swiftdoc'
 
177
htmlhelp_basename = 'swiftdoc'
177
178
 
178
179
 
179
180
# -- Options for LaTeX output --------------------------------------------------
207
208
 
208
209
# If false, no module index is generated.
209
210
#latex_use_modindex = True
 
211
 
 
212
# Example configuration for intersphinx: refer to the Python standard library.
 
213
intersphinx_mapping = {'python': ('http://docs.python.org/', None),
 
214
                       'nova': ('http://nova.openstack.org', None)}
 
215