81 lines
2.8 KiB
Python
81 lines
2.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# system-config documentation build configuration file
|
|
|
|
import os
|
|
import sys
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
# 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
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
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 = ['custom_roles',
|
|
'openstackdocstheme',
|
|
'zuul_sphinx']
|
|
|
|
# We have roles split between zuul-suitable roles at top level roles/*
|
|
# (automatically detected by zuul-sphinx) and playbook-specific roles
|
|
# (might have plugins, etc that make them unsuitable as potential zuul
|
|
# roles). Document both.
|
|
zuul_role_paths = ['playbooks/roles']
|
|
|
|
# openstackdocstheme options
|
|
repository_name = 'opendev/system-config'
|
|
use_storyboard = True
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
copyright = u'2012-2018, OpenStack Infrastructure Team'
|
|
|
|
# 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 = 'sphinx'
|
|
|
|
|
|
# -- 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 = 'openstackdocs'
|
|
|
|
# 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
|
|
# documentation.
|
|
|
|
# To use the API Reference sidebar dropdown menu,
|
|
# uncomment the html_theme_options parameter. The theme
|
|
# variable, sidebar_dropdown, should be set to `api_ref`.
|
|
# Otherwise, the list of links for the User and Ops docs
|
|
# appear in the sidebar dropdown menu.
|
|
#html_theme_options = {'show_other_versions': True}
|
|
|
|
# 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/css']
|
|
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
# 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', 'system-config.tex', u'system-config Documentation',
|
|
u'OpenStack Infrastructure Team', 'manual'),
|
|
]
|