mox3/doc/source/conf.py
Doug Hellmann c919d92bb9 Fixes to allow a new release
Version 0.7.0 has a conflicting pbr requirement, so we need to update
the requirements and produce a new release. Making our tools work after
importing into gerrit required several updates simultaneously:

1. Update requirements based on our global-requirements list.
2. Fix tox.ini so tests pass for 2.7 and 3.4.
3. Skip a test that is failing for 3.4 until we have more time to debug.
4. Fix the .gitreview settings to point to the right repository.
5. Add skeleton documentation structure.
6. Add links to the README in a format understood by our release tools.

Related-bug: #1403214
Change-Id: I28213fb1dbb76a8640d7aa7dc844a7b593d1c6da
2015-06-11 17:22:23 +00:00

63 lines
1.9 KiB
Python

# -*- coding: utf-8 -*-
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- 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', 'oslosphinx']
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
# Add any paths that contain templates here, relative to this directory.
# templates_path = []
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'mox3'
copyright = u'OpenStack Foundation'
# 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
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- 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'
html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
html_last_updated_fmt = os.popen(git_cmd).read()
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
'%s Documentation' % project,
'OpenStack Foundation', 'manual'),
]