3079061ae0
* Fixes sphinx format issues in several docstrings * Adds cafe sphinx .rst source files * Converts docstrings in modules with sphinx errors from epydoc format to sphinx format. * Various pep8 fixes in touched files Change-Id: Ie2047c43285a29acfed2d014d1dc4858a20b1f9b
88 lines
2.4 KiB
Python
88 lines
2.4 KiB
Python
import sphinx_rtd_theme
|
|
import sys
|
|
import os
|
|
import shlex
|
|
|
|
package_path = os.path.abspath("../../../opencafe")
|
|
sys.path.append(package_path)
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.viewcode',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
# templates_path = ['_templates']
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'OpenCAFE'
|
|
copyright = u'2015, RackspaceQE'
|
|
|
|
# The short X.Y version.
|
|
version = '0.2.0'
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = '0.2.0'
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
exclude_patterns = ['_build']
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'monokai'
|
|
|
|
|
|
# -- Options for HTML output ----------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
theme_path = sphinx_rtd_theme.get_html_theme_path()
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_path = [theme_path]
|
|
|
|
# If true, links to the reST sources are added to the pages.
|
|
html_show_sourcelink = True
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'OpenCAFEdoc'
|
|
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
latex_elements = {}
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title,
|
|
# author, documentclass [howto, manual, or own class]).
|
|
latex_documents = [('index', 'OpenCAFE.tex', u'OpenCAFE Documentation',
|
|
u'Rackspace', 'manual')]
|
|
|
|
# -- Options for manual page output ---------------------------------------
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
('index', 'opencafe', u'OpenCAFE Documentation',
|
|
[u'Rackspace'], 1)
|
|
]
|
|
|
|
# -- Options for Texinfo output -------------------------------------------
|
|
|
|
# Grouping the document tree into Texinfo files. List of tuples
|
|
# (source start file, target name, title, author,
|
|
# dir menu entry, description, category)
|
|
texinfo_documents = [
|
|
('index',
|
|
'OpenCAFE',
|
|
u'OpenCAFE Documentation',
|
|
u'Rackspace',
|
|
'OpenCAFE',
|
|
'One line description of project.',
|
|
'Miscellaneous')]
|