1
# -*- coding: utf-8 -*-
3
# lazr.authentication documentation build configuration file, created by
4
# sphinx-quickstart on Sat Apr 28 19:41:59 2018.
6
# This file is execfile()d with the current directory set to its
9
# Note that not all possible configuration values are present in this
12
# All configuration values have a default; values that are commented out
13
# serve to show the default.
15
with open('../version.txt') as version_file:
16
_version = version_file.read().strip()
18
# If extensions (or modules to document with autodoc) are in another directory,
19
# add these directories to sys.path here. If the directory is relative to the
20
# documentation root, use os.path.abspath to make it absolute, like shown here.
23
# sys.path.insert(0, os.path.abspath('.'))
26
# -- General configuration ------------------------------------------------
28
# If your documentation needs a minimal Sphinx version, state it here.
30
# needs_sphinx = '1.0'
32
# Add any Sphinx extension module names here, as strings. They can be
33
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
37
# Add any paths that contain templates here, relative to this directory.
38
templates_path = ['_templates']
40
# The suffix(es) of source filenames.
41
# You can specify multiple suffix as a list of string:
43
# source_suffix = ['.rst', '.md']
44
source_suffix = '.rst'
46
# The master toctree document.
49
# General information about the project.
50
project = u'lazr.authentication'
51
copyright = u'2009-2018, Canonical Ltd.'
52
author = u'LAZR Developers <lazr-developers@lists.launchpad.net>'
54
# The version info for the project you're documenting, acts as replacement for
55
# |version| and |release|, also used in various other places throughout the
58
# The short X.Y version.
60
# The full version, including alpha/beta/rc tags.
63
# The language for content autogenerated by Sphinx. Refer to documentation
64
# for a list of supported languages.
66
# This is also used if you do content translation via gettext catalogs.
67
# Usually you set "language" from the command line for these cases.
70
# List of patterns, relative to source directory, that match files and
71
# directories to ignore when looking for source files.
72
# This patterns also effect to html_static_path and html_extra_path
73
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
75
# The name of the Pygments (syntax highlighting) style to use.
76
pygments_style = 'sphinx'
78
# If true, `todo` and `todoList` produce output, else they produce nothing.
79
todo_include_todos = False
82
# -- Options for HTML output ----------------------------------------------
84
# The theme to use for HTML and HTML Help pages. See the documentation for
85
# a list of builtin themes.
87
html_theme = 'alabaster'
89
# Theme options are theme-specific and customize the look and feel of a theme
90
# further. For a list of options available for each theme, see the
93
# html_theme_options = {}
95
# Add any paths that contain custom static files (such as style sheets) here,
96
# relative to this directory. They are copied after the builtin static files,
97
# so a file named "default.css" will overwrite the builtin "default.css".
98
#html_static_path = ['_static']
100
# Custom sidebar templates, must be a dictionary that maps document names
103
# This is required for the alabaster theme
104
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
107
'relations.html', # needs 'show_related': True theme option to display
113
# -- Options for HTMLHelp output ------------------------------------------
115
# Output file base name for HTML help builder.
116
htmlhelp_basename = 'lazrauthenticationdoc'
119
# -- Options for LaTeX output ---------------------------------------------
122
# The paper size ('letterpaper' or 'a4paper').
124
# 'papersize': 'letterpaper',
126
# The font size ('10pt', '11pt' or '12pt').
128
# 'pointsize': '10pt',
130
# Additional stuff for the LaTeX preamble.
134
# Latex figure (float) alignment
136
# 'figure_align': 'htbp',
139
# Grouping the document tree into LaTeX files. List of tuples
140
# (source start file, target name, title,
141
# author, documentclass [howto, manual, or own class]).
143
(master_doc, 'lazrauthentication.tex', u'lazr.authentication Documentation',
144
u'LAZR Developers \\textless{}lazr-developers@lists.launchpad.net\\textgreater{}', 'manual'),
148
# -- Options for manual page output ---------------------------------------
150
# One entry per manual page. List of tuples
151
# (source start file, name, description, authors, manual section).
153
(master_doc, 'lazrauthentication', u'lazr.authentication Documentation',
158
# -- Options for Texinfo output -------------------------------------------
160
# Grouping the document tree into Texinfo files. List of tuples
161
# (source start file, target name, title, author,
162
# dir menu entry, description, category)
163
texinfo_documents = [
164
(master_doc, 'lazrauthentication', u'lazr.authentication Documentation',
165
author, 'lazrauthentication', 'One line description of project.',
added
removed
src/lazr/authentication/docs/conf.py
