|
1 |
| -# -*- coding: utf-8 -*- |
2 | 1 | #
|
3 | 2 | # pysaml2 documentation build configuration file, created by
|
4 | 3 | # sphinx-quickstart on Mon Aug 24 08:13:41 2009.
|
|
11 | 10 | # All configuration values have a default; values that are commented out
|
12 | 11 | # serve to show the default.
|
13 | 12 |
|
14 |
| -from __future__ import unicode_literals |
15 | 13 |
|
16 | 14 | import os
|
17 | 15 |
|
18 | 16 | import alabaster
|
19 | 17 |
|
20 | 18 | import saml2.version
|
21 | 19 |
|
| 20 | + |
22 | 21 | # If extensions (or modules to document with autodoc) are in another directory,
|
23 | 22 | # add these directories to sys.path here. If the directory is relative to the
|
24 | 23 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
25 |
| -#sys.path.append(os.path.abspath('.')) |
| 24 | +# sys.path.append(os.path.abspath('.')) |
26 | 25 |
|
27 | 26 | # -- General configuration -----------------------------------------------------
|
28 | 27 |
|
29 | 28 | # Add any Sphinx extension module names here, as strings. They can be extensions
|
30 | 29 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
31 | 30 |
|
32 |
| -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage'] |
| 31 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.coverage"] |
33 | 32 |
|
34 | 33 | # Add any paths that contain templates here, relative to this directory.
|
35 |
| -templates_path = ['_templates'] |
| 34 | +templates_path = ["_templates"] |
36 | 35 |
|
37 | 36 | # The suffix of source filenames.
|
38 |
| -source_suffix = '.rst' |
| 37 | +source_suffix = ".rst" |
39 | 38 |
|
40 | 39 | # The encoding of source files.
|
41 |
| -#source_encoding = 'utf-8' |
| 40 | +# source_encoding = 'utf-8' |
42 | 41 |
|
43 | 42 | # The master toctree document.
|
44 |
| -master_doc = 'index' |
| 43 | +master_doc = "index" |
45 | 44 |
|
46 | 45 | # General information about the project.
|
47 |
| -project = 'pysaml2' |
48 |
| -copyright = '2010-2011, Roland Hedberg' |
| 46 | +project = "pysaml2" |
| 47 | +copyright = "2010-2011, Roland Hedberg" |
49 | 48 |
|
50 | 49 | # The version info for the project you're documenting, acts as replacement for
|
51 | 50 | # |version| and |release|, also used in various other places throughout the
|
|
54 | 53 | # The short X.Y version.
|
55 | 54 | version = str(saml2.version.version)
|
56 | 55 | # The full version, including alpha/beta/rc tags.
|
57 |
| -release = '' |
| 56 | +release = "" |
58 | 57 |
|
59 | 58 | # The language for content autogenerated by Sphinx. Refer to documentation
|
60 | 59 | # for a list of supported languages.
|
61 |
| -#language = None |
| 60 | +# language = None |
62 | 61 |
|
63 | 62 | # There are two options for replacing |today|: either, you set today to some
|
64 | 63 | # non-false value, then it is used:
|
65 |
| -#today = '' |
| 64 | +# today = '' |
66 | 65 | # Else, today_fmt is used as the format for a strftime call.
|
67 |
| -#today_fmt = '%B %d, %Y' |
| 66 | +# today_fmt = '%B %d, %Y' |
68 | 67 |
|
69 | 68 | # List of documents that shouldn't be included in the build.
|
70 |
| -#unused_docs = [] |
| 69 | +# unused_docs = [] |
71 | 70 |
|
72 | 71 | # List of directories, relative to source directory, that shouldn't be searched
|
73 | 72 | # for source files.
|
74 |
| -exclude_trees = ['_build'] |
| 73 | +exclude_trees = ["_build"] |
75 | 74 |
|
76 | 75 | # The reST default role (used for this markup: `text`) to use for all documents.
|
77 |
| -#default_role = None |
| 76 | +# default_role = None |
78 | 77 |
|
79 | 78 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
80 |
| -#add_function_parentheses = True |
| 79 | +# add_function_parentheses = True |
81 | 80 |
|
82 | 81 | # If true, the current module name will be prepended to all description
|
83 | 82 | # unit titles (such as .. function::).
|
84 |
| -#add_module_names = True |
| 83 | +# add_module_names = True |
85 | 84 |
|
86 | 85 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
87 | 86 | # output. They are ignored by default.
|
88 |
| -#show_authors = False |
| 87 | +# show_authors = False |
89 | 88 |
|
90 | 89 | # The name of the Pygments (syntax highlighting) style to use.
|
91 |
| -pygments_style = 'sphinx' |
| 90 | +pygments_style = "sphinx" |
92 | 91 |
|
93 | 92 | # A list of ignored prefixes for module index sorting.
|
94 |
| -#modindex_common_prefix = [] |
| 93 | +# modindex_common_prefix = [] |
95 | 94 |
|
96 | 95 |
|
97 | 96 | # -- Options for HTML output ---------------------------------------------------
|
98 | 97 |
|
99 | 98 | # The theme to use for HTML and HTML Help pages. Major themes that come with
|
100 | 99 | # Sphinx are currently 'default' and 'sphinxdoc'.
|
101 | 100 | html_theme_path = [alabaster.get_path()]
|
102 |
| -html_theme = 'alabaster' |
103 |
| -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 101 | +html_theme = "alabaster" |
| 102 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
104 | 103 |
|
105 | 104 | if on_rtd: # only import and set the theme if we're building docs locally
|
106 |
| - html_theme = 'sphinx_rtd_theme' |
| 105 | + html_theme = "sphinx_rtd_theme" |
107 | 106 |
|
108 | 107 |
|
109 | 108 | # Theme options are theme-specific and customize the look and feel of a theme
|
110 | 109 | # further. For a list of options available for each theme, see the
|
111 | 110 | # documentation.
|
112 |
| -#html_theme_options = {} |
| 111 | +# html_theme_options = {} |
113 | 112 |
|
114 | 113 | # Add any paths that contain custom themes here, relative to this directory.
|
115 |
| -#html_theme_path = [] |
| 114 | +# html_theme_path = [] |
116 | 115 |
|
117 | 116 | # The name for this set of Sphinx documents. If None, it defaults to
|
118 | 117 | # "<project> v<release> documentation".
|
119 |
| -#html_title = None |
| 118 | +# html_title = None |
120 | 119 |
|
121 | 120 | # A shorter title for the navigation bar. Default is the same as html_title.
|
122 |
| -#html_short_title = None |
| 121 | +# html_short_title = None |
123 | 122 |
|
124 | 123 | # The name of an image file (relative to this directory) to place at the top
|
125 | 124 | # of the sidebar.
|
126 |
| -#html_logo = None |
| 125 | +# html_logo = None |
127 | 126 |
|
128 | 127 | # The name of an image file (within the static path) to use as favicon of the
|
129 | 128 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
130 | 129 | # pixels large.
|
131 |
| -#html_favicon = None |
| 130 | +# html_favicon = None |
132 | 131 |
|
133 | 132 | # Add any paths that contain custom static files (such as style sheets) here,
|
134 | 133 | # relative to this directory. They are copied after the builtin static files,
|
135 | 134 | # so a file named "default.css" will overwrite the builtin "default.css".
|
136 |
| -html_static_path = ['_static'] |
| 135 | +html_static_path = ["_static"] |
137 | 136 |
|
138 | 137 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
139 | 138 | # using the given strftime format.
|
140 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 139 | +# html_last_updated_fmt = '%b %d, %Y' |
141 | 140 |
|
142 | 141 | # If true, SmartyPants will be used to convert quotes and dashes to
|
143 | 142 | # typographically correct entities.
|
144 |
| -#html_use_smartypants = True |
| 143 | +# html_use_smartypants = True |
145 | 144 |
|
146 | 145 | # Custom sidebar templates, maps document names to template names.
|
147 |
| -#html_sidebars = {} |
| 146 | +# html_sidebars = {} |
148 | 147 |
|
149 | 148 | # Additional templates that should be rendered to pages, maps page names to
|
150 | 149 | # template names.
|
151 |
| -#html_additional_pages = {} |
| 150 | +# html_additional_pages = {} |
152 | 151 |
|
153 | 152 | # If false, no module index is generated.
|
154 |
| -#html_use_modindex = True |
| 153 | +# html_use_modindex = True |
155 | 154 |
|
156 | 155 | # If false, no index is generated.
|
157 |
| -#html_use_index = True |
| 156 | +# html_use_index = True |
158 | 157 |
|
159 | 158 | # If true, the index is split into individual pages for each letter.
|
160 |
| -#html_split_index = False |
| 159 | +# html_split_index = False |
161 | 160 |
|
162 | 161 | # If true, links to the reST sources are added to the pages.
|
163 |
| -#html_show_sourcelink = True |
| 162 | +# html_show_sourcelink = True |
164 | 163 |
|
165 | 164 | # If true, an OpenSearch description file will be output, and all pages will
|
166 | 165 | # contain a <link> tag referring to it. The value of this option must be the
|
167 | 166 | # base URL from which the finished HTML is served.
|
168 |
| -#html_use_opensearch = '' |
| 167 | +# html_use_opensearch = '' |
169 | 168 |
|
170 | 169 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
171 |
| -#html_file_suffix = '' |
| 170 | +# html_file_suffix = '' |
172 | 171 |
|
173 | 172 | # Output file base name for HTML help builder.
|
174 |
| -htmlhelp_basename = 'pysaml2doc' |
| 173 | +htmlhelp_basename = "pysaml2doc" |
175 | 174 |
|
176 | 175 |
|
177 | 176 | # -- Options for LaTeX output --------------------------------------------------
|
178 | 177 |
|
179 | 178 | # The paper size ('letter' or 'a4').
|
180 |
| -#latex_paper_size = 'letter' |
| 179 | +# latex_paper_size = 'letter' |
181 | 180 |
|
182 | 181 | # The font size ('10pt', '11pt' or '12pt').
|
183 |
| -#latex_font_size = '10pt' |
| 182 | +# latex_font_size = '10pt' |
184 | 183 |
|
185 | 184 | # Grouping the document tree into LaTeX files. List of tuples
|
186 | 185 | # (source start file, target name, title, author, documentclass [howto/manual]).
|
187 | 186 | latex_documents = [
|
188 | 187 | (
|
189 |
| - 'index', |
190 |
| - 'pysaml2.tex', |
191 |
| - 'pysaml2 Documentation', |
192 |
| - 'Roland Hedberg', |
193 |
| - 'manual', |
| 188 | + "index", |
| 189 | + "pysaml2.tex", |
| 190 | + "pysaml2 Documentation", |
| 191 | + "Roland Hedberg", |
| 192 | + "manual", |
194 | 193 | ),
|
195 | 194 | ]
|
196 | 195 |
|
197 | 196 | # The name of an image file (relative to this directory) to place at the top of
|
198 | 197 | # the title page.
|
199 |
| -#latex_logo = None |
| 198 | +# latex_logo = None |
200 | 199 |
|
201 | 200 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
202 | 201 | # not chapters.
|
203 |
| -#latex_use_parts = False |
| 202 | +# latex_use_parts = False |
204 | 203 |
|
205 | 204 | # Additional stuff for the LaTeX preamble.
|
206 |
| -#latex_preamble = '' |
| 205 | +# latex_preamble = '' |
207 | 206 |
|
208 | 207 | # Documents to append as an appendix to all manuals.
|
209 |
| -#latex_appendices = [] |
| 208 | +# latex_appendices = [] |
210 | 209 |
|
211 | 210 | # If false, no module index is generated.
|
212 |
| -#latex_use_modindex = True |
| 211 | +# latex_use_modindex = True |
0 commit comments