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