lemur/docs/conf.py

278 lines
8.8 KiB
Python
Raw Normal View History

2015-06-22 22:47:27 +02:00
# -*- coding: utf-8 -*-
#
2015-09-19 00:50:59 +02:00
# lemur documentation build configuration file, created by
2015-06-22 22:47:27 +02:00
# sphinx-quickstart on Sat Jun 7 18:43:48 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
2017-09-11 18:18:03 +02:00
from unittest.mock import MagicMock
2015-06-22 22:47:27 +02:00
# 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.
2019-07-09 20:13:11 +02:00
sys.path.insert(0, os.path.abspath(".."))
2015-06-22 22:47:27 +02:00
2017-09-11 18:18:03 +02:00
# Mock packages that cannot be installed on rtd
2019-07-09 20:13:11 +02:00
on_rtd = os.environ.get("READTHEDOCS") == "True"
2017-09-11 18:18:03 +02:00
if on_rtd:
2019-07-09 20:13:11 +02:00
2017-09-11 18:18:03 +02:00
class Mock(MagicMock):
@classmethod
def __getattr__(cls, name):
return MagicMock()
2019-07-09 20:13:11 +02:00
MOCK_MODULES = ["ldap"]
2017-09-11 18:18:03 +02:00
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
2015-06-22 22:47:27 +02:00
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
2019-07-09 20:13:11 +02:00
# needs_sphinx = '1.0'
2015-06-22 22:47:27 +02:00
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
2019-07-09 20:13:11 +02:00
extensions = ["sphinx.ext.autodoc", "sphinxcontrib.autohttp.flask", "sphinx.ext.todo"]
2015-06-22 22:47:27 +02:00
# Add any paths that contain templates here, relative to this directory.
2019-07-09 20:13:11 +02:00
templates_path = ["_templates"]
2015-06-22 22:47:27 +02:00
# The suffix of source filenames.
2019-07-09 20:13:11 +02:00
source_suffix = ".rst"
2015-06-22 22:47:27 +02:00
# The encoding of source files.
2019-07-09 20:13:11 +02:00
# source_encoding = 'utf-8-sig'
2015-06-22 22:47:27 +02:00
# The master toctree document.
2019-07-09 20:13:11 +02:00
master_doc = "index"
2015-06-22 22:47:27 +02:00
# General information about the project.
2019-07-09 20:13:11 +02:00
project = u"lemur"
copyright = u"2018, Netflix Inc."
2015-06-22 22:47:27 +02:00
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
2015-12-01 18:15:53 +01:00
base_dir = os.path.join(os.path.dirname(__file__), os.pardir)
about = {}
with open(os.path.join(base_dir, "lemur", "__about__.py")) as f:
2019-05-10 00:00:09 +02:00
exec(f.read(), about) # nosec
2015-12-01 18:15:53 +01:00
version = release = about["__version__"]
2015-06-22 22:47:27 +02:00
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
2019-07-09 20:13:11 +02:00
# language = None
2015-06-22 22:47:27 +02:00
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
2019-07-09 20:13:11 +02:00
# today = ''
2015-06-22 22:47:27 +02:00
# Else, today_fmt is used as the format for a strftime call.
2019-07-09 20:13:11 +02:00
# today_fmt = '%B %d, %Y'
2015-06-22 22:47:27 +02:00
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
2019-07-09 20:13:11 +02:00
exclude_patterns = ["_build"]
2015-06-22 22:47:27 +02:00
# The reST default role (used for this markup: `text`) to use for all
# documents.
2019-07-09 20:13:11 +02:00
# default_role = None
2015-06-22 22:47:27 +02:00
# If true, '()' will be appended to :func: etc. cross-reference text.
2019-07-09 20:13:11 +02:00
# add_function_parentheses = True
2015-06-22 22:47:27 +02:00
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
2019-07-09 20:13:11 +02:00
# add_module_names = True
2015-06-22 22:47:27 +02:00
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
2019-07-09 20:13:11 +02:00
# show_authors = False
2015-06-22 22:47:27 +02:00
# The name of the Pygments (syntax highlighting) style to use.
2019-07-09 20:13:11 +02:00
pygments_style = "sphinx"
2015-06-22 22:47:27 +02:00
# A list of ignored prefixes for module index sorting.
2019-07-09 20:13:11 +02:00
# modindex_common_prefix = []
2015-06-22 22:47:27 +02:00
# If true, keep warnings as "system message" paragraphs in the built documents.
2019-07-09 20:13:11 +02:00
# keep_warnings = False
2015-06-22 22:47:27 +02:00
# -- Options for HTML output ----------------------------------------------
2015-12-31 20:12:56 +01:00
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
2019-07-09 20:13:11 +02:00
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
2015-12-31 20:12:56 +01:00
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
2019-07-09 20:13:11 +02:00
html_theme = "sphinx_rtd_theme"
2015-12-31 20:12:56 +01:00
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
2015-06-22 22:47:27 +02:00
# 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.
2019-07-09 20:13:11 +02:00
# html_theme_options = {}
2015-06-22 22:47:27 +02:00
# Add any paths that contain custom themes here, relative to this directory.
2019-07-09 20:13:11 +02:00
# html_theme_path = []
2015-06-22 22:47:27 +02:00
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
2019-07-09 20:13:11 +02:00
# html_title = None
2015-06-22 22:47:27 +02:00
# A shorter title for the navigation bar. Default is the same as html_title.
2019-07-09 20:13:11 +02:00
# html_short_title = None
2015-06-22 22:47:27 +02:00
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
2019-07-09 20:13:11 +02:00
# html_logo = None
2015-06-22 22:47:27 +02:00
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
2019-07-09 20:13:11 +02:00
# html_favicon = None
2015-06-22 22:47:27 +02:00
# 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".
2019-07-09 20:13:11 +02:00
html_static_path = ["_static"]
2015-06-22 22:47:27 +02:00
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
2019-07-09 20:13:11 +02:00
# html_extra_path = []
2015-06-22 22:47:27 +02:00
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
2019-07-09 20:13:11 +02:00
# html_last_updated_fmt = '%b %d, %Y'
2015-06-22 22:47:27 +02:00
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
2019-07-09 20:13:11 +02:00
# html_use_smartypants = True
2015-06-22 22:47:27 +02:00
# Custom sidebar templates, maps document names to template names.
2019-07-09 20:13:11 +02:00
# html_sidebars = {}
2015-06-22 22:47:27 +02:00
# Additional templates that should be rendered to pages, maps page names to
# template names.
2019-07-09 20:13:11 +02:00
# html_additional_pages = {}
2015-06-22 22:47:27 +02:00
# If false, no module index is generated.
2019-07-09 20:13:11 +02:00
# html_domain_indices = True
2015-06-22 22:47:27 +02:00
# If false, no index is generated.
2019-07-09 20:13:11 +02:00
# html_use_index = True
2015-06-22 22:47:27 +02:00
# If true, the index is split into individual pages for each letter.
2019-07-09 20:13:11 +02:00
# html_split_index = False
2015-06-22 22:47:27 +02:00
# If true, links to the reST sources are added to the pages.
2019-07-09 20:13:11 +02:00
# html_show_sourcelink = True
2015-06-22 22:47:27 +02:00
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
2019-07-09 20:13:11 +02:00
# html_show_sphinx = True
2015-06-22 22:47:27 +02:00
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
2019-07-09 20:13:11 +02:00
# html_show_copyright = True
2015-06-22 22:47:27 +02:00
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
2019-07-09 20:13:11 +02:00
# html_use_opensearch = ''
2015-06-22 22:47:27 +02:00
# This is the file name suffix for HTML files (e.g. ".xhtml").
2019-07-09 20:13:11 +02:00
# html_file_suffix = None
2015-06-22 22:47:27 +02:00
# Output file base name for HTML help builder.
2019-07-09 20:13:11 +02:00
htmlhelp_basename = "lemurdoc"
2015-06-22 22:47:27 +02:00
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
2019-07-09 20:13:11 +02:00
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
2015-06-22 22:47:27 +02:00
}
# 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 = [
2019-07-09 20:13:11 +02:00
("index", "lemur.tex", u"Lemur Documentation", u"Netflix Security", "manual")
2015-06-22 22:47:27 +02:00
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
2019-07-09 20:13:11 +02:00
# latex_logo = None
2015-06-22 22:47:27 +02:00
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
2019-07-09 20:13:11 +02:00
# latex_use_parts = False
2015-06-22 22:47:27 +02:00
# If true, show page references after internal links.
2019-07-09 20:13:11 +02:00
# latex_show_pagerefs = False
2015-06-22 22:47:27 +02:00
# If true, show URL addresses after external links.
2019-07-09 20:13:11 +02:00
# latex_show_urls = False
2015-06-22 22:47:27 +02:00
# Documents to append as an appendix to all manuals.
2019-07-09 20:13:11 +02:00
# latex_appendices = []
2015-06-22 22:47:27 +02:00
# If false, no module index is generated.
2019-07-09 20:13:11 +02:00
# latex_domain_indices = True
2015-06-22 22:47:27 +02:00
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
2019-07-09 20:13:11 +02:00
man_pages = [("index", "Lemur", u"Lemur Documentation", [u"Netflix Security"], 1)]
2015-06-22 22:47:27 +02:00
# If true, show URL addresses after external links.
2019-07-09 20:13:11 +02:00
# man_show_urls = False
2015-06-22 22:47:27 +02:00
# -- 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 = [
2019-07-09 20:13:11 +02:00
(
"index",
"Lemur",
u"Lemur Documentation",
u"Netflix Security",
"Lemur",
"SSL Certificate Management",
"Miscellaneous",
)
2015-06-22 22:47:27 +02:00
]
# Documents to append as an appendix to all manuals.
2019-07-09 20:13:11 +02:00
# texinfo_appendices = []
2015-06-22 22:47:27 +02:00
# If false, no module index is generated.
2019-07-09 20:13:11 +02:00
# texinfo_domain_indices = True
2015-06-22 22:47:27 +02:00
# How to display URL addresses: 'footnote', 'no', or 'inline'.
2019-07-09 20:13:11 +02:00
# texinfo_show_urls = 'footnote'
2015-06-22 22:47:27 +02:00
# If true, do not generate a @detailmenu in the "Top" node's menu.
2019-07-09 20:13:11 +02:00
# texinfo_no_detailmenu = False