|
21 | 21 | # sys.path.insert(0, os.path.abspath('.')) |
22 | 22 |
|
23 | 23 | import os |
| 24 | + |
24 | 25 | from reversion import __version__ |
25 | 26 |
|
26 | 27 | # -- General configuration ------------------------------------------------ |
|
45 | 46 | # You can specify multiple suffix as a list of string: |
46 | 47 | # |
47 | 48 | # source_suffix = ['.rst', '.md'] |
48 | | -source_suffix = '.rst' |
| 49 | +source_suffix = ".rst" |
49 | 50 |
|
50 | 51 | # The encoding of source files. |
51 | 52 | # |
52 | 53 | # source_encoding = 'utf-8-sig' |
53 | 54 |
|
54 | 55 | # The master toctree document. |
55 | | -master_doc = 'index' |
| 56 | +master_doc = "index" |
56 | 57 |
|
57 | 58 | # General information about the project. |
58 | | -project = 'django-reversion' |
59 | | -copyright = '2016, Dave Hall' |
60 | | -author = 'Dave Hall' |
| 59 | +project = "django-reversion" |
| 60 | +copyright = "2016, Dave Hall" |
| 61 | +author = "Dave Hall" |
61 | 62 |
|
62 | 63 | # The version info for the project you're documenting, acts as replacement for |
63 | 64 | # |version| and |release|, also used in various other places throughout the |
64 | 65 | # built documents. |
65 | 66 | # |
66 | 67 | # The short X.Y version. |
67 | | -version = '.'.join(str(x) for x in __version__[:2]) |
| 68 | +version = ".".join(str(x) for x in __version__[:2]) |
68 | 69 | # The full version, including alpha/beta/rc tags. |
69 | | -release = '.'.join(str(x) for x in __version__) |
| 70 | +release = ".".join(str(x) for x in __version__) |
70 | 71 |
|
71 | 72 | # The language for content autogenerated by Sphinx. Refer to documentation |
72 | 73 | # for a list of supported languages. |
73 | 74 | # |
74 | 75 | # This is also used if you do content translation via gettext catalogs. |
75 | 76 | # Usually you set "language" from the command line for these cases. |
76 | | -language = 'en' |
| 77 | +language = "en" |
77 | 78 |
|
78 | 79 | # There are two options for replacing |today|: either, you set today to some |
79 | 80 | # non-false value, then it is used: |
|
87 | 88 | # List of patterns, relative to source directory, that match files and |
88 | 89 | # directories to ignore when looking for source files. |
89 | 90 | # This patterns also effect to html_static_path and html_extra_path |
90 | | -exclude_patterns = ['_build', '_include', 'Thumbs.db', '.DS_Store'] |
| 91 | +exclude_patterns = ["_build", "_include", "Thumbs.db", ".DS_Store"] |
91 | 92 |
|
92 | 93 | # The reST default role (used for this markup: `text`) to use for all |
93 | 94 | # documents. |
|
109 | 110 | # show_authors = False |
110 | 111 |
|
111 | 112 | # The name of the Pygments (syntax highlighting) style to use. |
112 | | -pygments_style = 'sphinx' |
| 113 | +pygments_style = "sphinx" |
113 | 114 |
|
114 | 115 | # A list of ignored prefixes for module index sorting. |
115 | 116 | # modindex_common_prefix = [] |
|
126 | 127 | # -- Options for HTML output ---------------------------------------------- |
127 | 128 |
|
128 | 129 | # Use RTD theme locally. |
129 | | -if not os.environ.get('READTHEDOCS', None) == 'True': |
130 | | - import sphinx_rtd_theme |
| 130 | +if not os.environ.get("READTHEDOCS", None) == "True": |
131 | 131 | html_theme = "sphinx_rtd_theme" |
132 | | - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
133 | 132 |
|
134 | 133 | # The name for this set of Sphinx documents. |
135 | 134 | # "<project> v<release> documentation" by default. |
|
234 | 233 | # html_search_scorer = 'scorer.js' |
235 | 234 |
|
236 | 235 | # Output file base name for HTML help builder. |
237 | | -htmlhelp_basename = 'django-reversiondoc' |
| 236 | +htmlhelp_basename = "django-reversiondoc" |
238 | 237 |
|
239 | 238 | # -- Options for LaTeX output --------------------------------------------- |
240 | 239 |
|
241 | 240 | latex_elements = { |
242 | | - # The paper size ('letterpaper' or 'a4paper'). |
243 | | - # |
244 | | - # 'papersize': 'letterpaper', |
245 | | - |
246 | | - # The font size ('10pt', '11pt' or '12pt'). |
247 | | - # |
248 | | - # 'pointsize': '10pt', |
249 | | - |
250 | | - # Additional stuff for the LaTeX preamble. |
251 | | - # |
252 | | - # 'preamble': '', |
253 | | - |
254 | | - # Latex figure (float) alignment |
255 | | - # |
256 | | - # 'figure_align': 'htbp', |
| 241 | + # The paper size ('letterpaper' or 'a4paper'). |
| 242 | + # |
| 243 | + # 'papersize': 'letterpaper', |
| 244 | + # The font size ('10pt', '11pt' or '12pt'). |
| 245 | + # |
| 246 | + # 'pointsize': '10pt', |
| 247 | + # Additional stuff for the LaTeX preamble. |
| 248 | + # |
| 249 | + # 'preamble': '', |
| 250 | + # Latex figure (float) alignment |
| 251 | + # |
| 252 | + # 'figure_align': 'htbp', |
257 | 253 | } |
258 | 254 |
|
259 | 255 | # Grouping the document tree into LaTeX files. List of tuples |
260 | 256 | # (source start file, target name, title, |
261 | 257 | # author, documentclass [howto, manual, or own class]). |
262 | 258 | latex_documents = [ |
263 | | - (master_doc, 'django-reversion.tex', 'django-reversion Documentation', |
264 | | - 'Dave Hall', 'manual'), |
| 259 | + ( |
| 260 | + master_doc, |
| 261 | + "django-reversion.tex", |
| 262 | + "django-reversion Documentation", |
| 263 | + "Dave Hall", |
| 264 | + "manual", |
| 265 | + ), |
265 | 266 | ] |
266 | 267 |
|
267 | 268 | # The name of an image file (relative to this directory) to place at the top of |
|
296 | 297 | # One entry per manual page. List of tuples |
297 | 298 | # (source start file, name, description, authors, manual section). |
298 | 299 | man_pages = [ |
299 | | - (master_doc, 'django-reversion', 'django-reversion Documentation', |
300 | | - [author], 1) |
| 300 | + (master_doc, "django-reversion", "django-reversion Documentation", [author], 1) |
301 | 301 | ] |
302 | 302 |
|
303 | 303 | # If true, show URL addresses after external links. |
|
311 | 311 | # (source start file, target name, title, author, |
312 | 312 | # dir menu entry, description, category) |
313 | 313 | texinfo_documents = [ |
314 | | - (master_doc, 'django-reversion', 'django-reversion Documentation', |
315 | | - author, 'django-reversion', 'One line description of project.', |
316 | | - 'Miscellaneous'), |
| 314 | + ( |
| 315 | + master_doc, |
| 316 | + "django-reversion", |
| 317 | + "django-reversion Documentation", |
| 318 | + author, |
| 319 | + "django-reversion", |
| 320 | + "One line description of project.", |
| 321 | + "Miscellaneous", |
| 322 | + ), |
317 | 323 | ] |
318 | 324 |
|
319 | 325 | # Documents to append as an appendix to all manuals. |
|
0 commit comments