|
1 |
| -# -*- coding: utf-8 -*- |
2 |
| -# |
3 | 1 | # Pipeline documentation build configuration file, created by
|
4 | 2 | # sphinx-quickstart on Sat Apr 30 17:47:55 2011.
|
5 | 3 | #
|
|
15 | 13 | # If extensions (or modules to document with autodoc) are in another directory,
|
16 | 14 | # add these directories to sys.path here. If the directory is relative to the
|
17 | 15 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
18 |
| -#sys.path.insert(0, os.path.abspath('.')) |
| 16 | +# sys.path.insert(0, os.path.abspath('.')) |
19 | 17 |
|
20 | 18 | # -- General configuration -----------------------------------------------------
|
21 | 19 |
|
22 | 20 | # If your documentation needs a minimal Sphinx version, state it here.
|
23 |
| -#needs_sphinx = '1.0' |
| 21 | +# needs_sphinx = '1.0' |
24 | 22 |
|
25 | 23 | # Add any Sphinx extension module names here, as strings. They can be extensions
|
26 | 24 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
33 | 31 | source_suffix = '.rst'
|
34 | 32 |
|
35 | 33 | # The encoding of source files.
|
36 |
| -#source_encoding = 'utf-8-sig' |
| 34 | +# source_encoding = 'utf-8-sig' |
37 | 35 |
|
38 | 36 | # The master toctree document.
|
39 | 37 | master_doc = 'index'
|
|
53 | 51 |
|
54 | 52 | # The language for content autogenerated by Sphinx. Refer to documentation
|
55 | 53 | # for a list of supported languages.
|
56 |
| -#language = None |
| 54 | +# language = None |
57 | 55 |
|
58 | 56 | # There are two options for replacing |today|: either, you set today to some
|
59 | 57 | # non-false value, then it is used:
|
60 |
| -#today = '' |
| 58 | +# today = '' |
61 | 59 | # Else, today_fmt is used as the format for a strftime call.
|
62 |
| -#today_fmt = '%B %d, %Y' |
| 60 | +# today_fmt = '%B %d, %Y' |
63 | 61 |
|
64 | 62 | # List of patterns, relative to source directory, that match files and
|
65 | 63 | # directories to ignore when looking for source files.
|
66 | 64 | exclude_patterns = ['_build']
|
67 | 65 |
|
68 | 66 | # The reST default role (used for this markup: `text`) to use for all documents.
|
69 |
| -#default_role = None |
| 67 | +# default_role = None |
70 | 68 |
|
71 | 69 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
72 |
| -#add_function_parentheses = True |
| 70 | +# add_function_parentheses = True |
73 | 71 |
|
74 | 72 | # If true, the current module name will be prepended to all description
|
75 | 73 | # unit titles (such as .. function::).
|
76 |
| -#add_module_names = True |
| 74 | +# add_module_names = True |
77 | 75 |
|
78 | 76 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
79 | 77 | # output. They are ignored by default.
|
80 |
| -#show_authors = False |
| 78 | +# show_authors = False |
81 | 79 |
|
82 | 80 | # The name of the Pygments (syntax highlighting) style to use.
|
83 | 81 | pygments_style = 'sphinx'
|
84 | 82 |
|
85 | 83 | # A list of ignored prefixes for module index sorting.
|
86 |
| -#modindex_common_prefix = [] |
| 84 | +# modindex_common_prefix = [] |
87 | 85 |
|
88 | 86 |
|
89 | 87 | # -- Options for HTML output ---------------------------------------------------
|
|
95 | 93 | # Theme options are theme-specific and customize the look and feel of a theme
|
96 | 94 | # further. For a list of options available for each theme, see the
|
97 | 95 | # documentation.
|
98 |
| -#html_theme_options = {} |
| 96 | +# html_theme_options = {} |
99 | 97 |
|
100 | 98 | # Add any paths that contain custom themes here, relative to this directory.
|
101 |
| -#html_theme_path = [] |
| 99 | +# html_theme_path = [] |
102 | 100 |
|
103 | 101 | # The name for this set of Sphinx documents. If None, it defaults to
|
104 | 102 | # "<project> v<release> documentation".
|
105 |
| -#html_title = None |
| 103 | +# html_title = None |
106 | 104 |
|
107 | 105 | # A shorter title for the navigation bar. Default is the same as html_title.
|
108 |
| -#html_short_title = None |
| 106 | +# html_short_title = None |
109 | 107 |
|
110 | 108 | # The name of an image file (relative to this directory) to place at the top
|
111 | 109 | # of the sidebar.
|
112 |
| -#html_logo = None |
| 110 | +# html_logo = None |
113 | 111 |
|
114 | 112 | # The name of an image file (within the static path) to use as favicon of the
|
115 | 113 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
116 | 114 | # pixels large.
|
117 |
| -#html_favicon = None |
| 115 | +# html_favicon = None |
118 | 116 |
|
119 | 117 | # Add any paths that contain custom static files (such as style sheets) here,
|
120 | 118 | # relative to this directory. They are copied after the builtin static files,
|
121 | 119 | # so a file named "default.css" will overwrite the builtin "default.css".
|
122 |
| -#html_static_path = ['_static'] |
| 120 | +# html_static_path = ['_static'] |
123 | 121 |
|
124 | 122 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
125 | 123 | # using the given strftime format.
|
126 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 124 | +# html_last_updated_fmt = '%b %d, %Y' |
127 | 125 |
|
128 | 126 | # If true, SmartyPants will be used to convert quotes and dashes to
|
129 | 127 | # typographically correct entities.
|
130 |
| -#html_use_smartypants = True |
| 128 | +# html_use_smartypants = True |
131 | 129 |
|
132 | 130 | # Custom sidebar templates, maps document names to template names.
|
133 |
| -#html_sidebars = {} |
| 131 | +# html_sidebars = {} |
134 | 132 |
|
135 | 133 | # Additional templates that should be rendered to pages, maps page names to
|
136 | 134 | # template names.
|
137 |
| -#html_additional_pages = {} |
| 135 | +# html_additional_pages = {} |
138 | 136 |
|
139 | 137 | # If false, no module index is generated.
|
140 |
| -#html_domain_indices = True |
| 138 | +# html_domain_indices = True |
141 | 139 |
|
142 | 140 | # If false, no index is generated.
|
143 |
| -#html_use_index = True |
| 141 | +# html_use_index = True |
144 | 142 |
|
145 | 143 | # If true, the index is split into individual pages for each letter.
|
146 |
| -#html_split_index = False |
| 144 | +# html_split_index = False |
147 | 145 |
|
148 | 146 | # If true, links to the reST sources are added to the pages.
|
149 |
| -#html_show_sourcelink = True |
| 147 | +# html_show_sourcelink = True |
150 | 148 |
|
151 | 149 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
152 |
| -#html_show_sphinx = True |
| 150 | +# html_show_sphinx = True |
153 | 151 |
|
154 | 152 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
155 |
| -#html_show_copyright = True |
| 153 | +# html_show_copyright = True |
156 | 154 |
|
157 | 155 | # If true, an OpenSearch description file will be output, and all pages will
|
158 | 156 | # contain a <link> tag referring to it. The value of this option must be the
|
159 | 157 | # base URL from which the finished HTML is served.
|
160 |
| -#html_use_opensearch = '' |
| 158 | +# html_use_opensearch = '' |
161 | 159 |
|
162 | 160 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
163 |
| -#html_file_suffix = None |
| 161 | +# html_file_suffix = None |
164 | 162 |
|
165 | 163 | # Output file base name for HTML help builder.
|
166 | 164 | htmlhelp_basename = 'django-pipelinedoc'
|
|
169 | 167 | # -- Options for LaTeX output --------------------------------------------------
|
170 | 168 |
|
171 | 169 | # The paper size ('letter' or 'a4').
|
172 |
| -#latex_paper_size = 'letter' |
| 170 | +# latex_paper_size = 'letter' |
173 | 171 |
|
174 | 172 | # The font size ('10pt', '11pt' or '12pt').
|
175 |
| -#latex_font_size = '10pt' |
| 173 | +# latex_font_size = '10pt' |
176 | 174 |
|
177 | 175 | # Grouping the document tree into LaTeX files. List of tuples
|
178 | 176 | # (source start file, target name, title, author, documentclass [howto/manual]).
|
|
183 | 181 |
|
184 | 182 | # The name of an image file (relative to this directory) to place at the top of
|
185 | 183 | # the title page.
|
186 |
| -#latex_logo = None |
| 184 | +# latex_logo = None |
187 | 185 |
|
188 | 186 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
189 | 187 | # not chapters.
|
190 |
| -#latex_use_parts = False |
| 188 | +# latex_use_parts = False |
191 | 189 |
|
192 | 190 | # If true, show page references after internal links.
|
193 |
| -#latex_show_pagerefs = False |
| 191 | +# latex_show_pagerefs = False |
194 | 192 |
|
195 | 193 | # If true, show URL addresses after external links.
|
196 |
| -#latex_show_urls = False |
| 194 | +# latex_show_urls = False |
197 | 195 |
|
198 | 196 | # Additional stuff for the LaTeX preamble.
|
199 |
| -#latex_preamble = '' |
| 197 | +# latex_preamble = '' |
200 | 198 |
|
201 | 199 | # Documents to append as an appendix to all manuals.
|
202 |
| -#latex_appendices = [] |
| 200 | +# latex_appendices = [] |
203 | 201 |
|
204 | 202 | # If false, no module index is generated.
|
205 |
| -#latex_domain_indices = True |
| 203 | +# latex_domain_indices = True |
206 | 204 |
|
207 | 205 |
|
208 | 206 | # -- Options for manual page output --------------------------------------------
|
|
0 commit comments