← Back to branch summary

~lazr-developers/lazr.enum/trunk

« back to all changes in this revision

Viewing changes to src/lazr/enum/docs/conf.py

  • Committer: Colin Watson
  • Date: 2019-11-04 10:36:11 UTC
  • mfrom: (32.1.1 tox)
  • Revision ID: cjwatson@canonical.com-20191104103611-98sjms8r2jsooloe
[r=doismellburning] Switch from buildout to tox.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/lazr/enum/docs/conf.py
 
1
# -*- coding: utf-8 -*-
 
2
#
 
3
# lazr.enum documentation build configuration file, created by
 
4
# sphinx-quickstart on Sun Oct  6 20:38:26 2019.
 
5
#
 
6
# This file is execfile()d with the current directory set to its
 
7
# containing dir.
 
8
#
 
9
# Note that not all possible configuration values are present in this
 
10
# autogenerated file.
 
11
#
 
12
# All configuration values have a default; values that are commented out
 
13
# serve to show the default.
 
14
 
 
15
with open('../version.txt') as version_file:
 
16
    _version = version_file.read().strip()
 
17
 
 
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.
 
21
#
 
22
# import os
 
23
# import sys
 
24
# sys.path.insert(0, os.path.abspath('.'))
 
25
 
 
26
 
 
27
# -- General configuration ------------------------------------------------
 
28
 
 
29
# If your documentation needs a minimal Sphinx version, state it here.
 
30
#
 
31
# needs_sphinx = '1.0'
 
32
 
 
33
# Add any Sphinx extension module names here, as strings. They can be
 
34
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 
35
# ones.
 
36
extensions = []
 
37
 
 
38
# Add any paths that contain templates here, relative to this directory.
 
39
templates_path = ['_templates']
 
40
 
 
41
# The suffix(es) of source filenames.
 
42
# You can specify multiple suffix as a list of string:
 
43
#
 
44
# source_suffix = ['.rst', '.md']
 
45
source_suffix = '.rst'
 
46
 
 
47
# The master toctree document.
 
48
master_doc = 'index'
 
49
 
 
50
# General information about the project.
 
51
project = u'lazr.enum'
 
52
copyright = u'2004-2019, Canonical Ltd.'
 
53
author = u'LAZR Developers <lazr-developers@lists.launchpad.net>'
 
54
 
 
55
# The version info for the project you're documenting, acts as replacement for
 
56
# |version| and |release|, also used in various other places throughout the
 
57
# built documents.
 
58
#
 
59
# The short X.Y version.
 
60
version = _version
 
61
# The full version, including alpha/beta/rc tags.
 
62
release = _version
 
63
 
 
64
# The language for content autogenerated by Sphinx. Refer to documentation
 
65
# for a list of supported languages.
 
66
#
 
67
# This is also used if you do content translation via gettext catalogs.
 
68
# Usually you set "language" from the command line for these cases.
 
69
language = None
 
70
 
 
71
# List of patterns, relative to source directory, that match files and
 
72
# directories to ignore when looking for source files.
 
73
# This patterns also effect to html_static_path and html_extra_path
 
74
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
75
 
 
76
# The name of the Pygments (syntax highlighting) style to use.
 
77
pygments_style = 'sphinx'
 
78
 
 
79
# If true, `todo` and `todoList` produce output, else they produce nothing.
 
80
todo_include_todos = False
 
81
 
 
82
 
 
83
# -- Options for HTML output ----------------------------------------------
 
84
 
 
85
# The theme to use for HTML and HTML Help pages.  See the documentation for
 
86
# a list of builtin themes.
 
87
#
 
88
html_theme = 'alabaster'
 
89
 
 
90
# Theme options are theme-specific and customize the look and feel of a theme
 
91
# further.  For a list of options available for each theme, see the
 
92
# documentation.
 
93
#
 
94
# html_theme_options = {}
 
95
 
 
96
# Add any paths that contain custom static files (such as style sheets) here,
 
97
# relative to this directory. They are copied after the builtin static files,
 
98
# so a file named "default.css" will overwrite the builtin "default.css".
 
99
#html_static_path = ['_static']
 
100
 
 
101
# Custom sidebar templates, must be a dictionary that maps document names
 
102
# to template names.
 
103
#
 
104
# This is required for the alabaster theme
 
105
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 
106
html_sidebars = {
 
107
    '**': [
 
108
        'relations.html',  # needs 'show_related': True theme option to display
 
109
        'searchbox.html',
 
110
    ]
 
111
}
 
112
 
 
113
 
 
114
# -- Options for HTMLHelp output ------------------------------------------
 
115
 
 
116
# Output file base name for HTML help builder.
 
117
htmlhelp_basename = 'lazrenumdoc'
 
118
 
 
119
 
 
120
# -- Options for LaTeX output ---------------------------------------------
 
121
 
 
122
latex_elements = {
 
123
    # The paper size ('letterpaper' or 'a4paper').
 
124
    #
 
125
    # 'papersize': 'letterpaper',
 
126
 
 
127
    # The font size ('10pt', '11pt' or '12pt').
 
128
    #
 
129
    # 'pointsize': '10pt',
 
130
 
 
131
    # Additional stuff for the LaTeX preamble.
 
132
    #
 
133
    # 'preamble': '',
 
134
 
 
135
    # Latex figure (float) alignment
 
136
    #
 
137
    # 'figure_align': 'htbp',
 
138
}
 
139
 
 
140
# Grouping the document tree into LaTeX files. List of tuples
 
141
# (source start file, target name, title,
 
142
#  author, documentclass [howto, manual, or own class]).
 
143
latex_documents = [
 
144
    (master_doc, 'lazrenum.tex', u'lazr.enum Documentation',
 
145
     u'LAZR Developers', 'manual'),
 
146
]
 
147
 
 
148
 
 
149
# -- Options for manual page output ---------------------------------------
 
150
 
 
151
# One entry per manual page. List of tuples
 
152
# (source start file, name, description, authors, manual section).
 
153
man_pages = [
 
154
    (master_doc, 'lazrenum', u'lazr.enum Documentation',
 
155
     [author], 1)
 
156
]
 
157
 
 
158
 
 
159
# -- Options for Texinfo output -------------------------------------------
 
160
 
 
161
# Grouping the document tree into Texinfo files. List of tuples
 
162
# (source start file, target name, title, author,
 
163
#  dir menu entry, description, category)
 
164
texinfo_documents = [
 
165
    (master_doc, 'lazrenum', u'lazr.enum Documentation',
 
166
     author, 'lazrenum', 'One line description of project.',
 
167
     'Miscellaneous'),
 
168
]
 
169
 
 
170
 
 
171