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