|
33 | 33 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
34 | 34 | # ones. |
35 | 35 | extensions = [ |
36 | | - 'sphinx.ext.autodoc', |
37 | | - 'sphinx.ext.viewcode', |
38 | | - 'openwisp.sphinx.theme', |
| 36 | + "sphinx.ext.autodoc", |
| 37 | + "sphinx.ext.viewcode", |
| 38 | + "openwisp.sphinx.theme", |
39 | 39 | ] |
40 | 40 |
|
41 | 41 | # Add any paths that contain templates here, relative to this directory. |
42 | | -templates_path = ['_templates'] |
| 42 | +templates_path = ["_templates"] |
43 | 43 |
|
44 | 44 | # The suffix(es) of source filenames. |
45 | 45 | # You can specify multiple suffix as a list of string: |
46 | 46 | # source_suffix = ['.rst', '.md'] |
47 | | -source_suffix = '.rst' |
| 47 | +source_suffix = ".rst" |
48 | 48 |
|
49 | 49 | # The encoding of source files. |
50 | 50 | # source_encoding = 'utf-8-sig' |
51 | 51 |
|
52 | 52 | # The master toctree document. |
53 | | -master_doc = 'index' |
| 53 | +master_doc = "index" |
54 | 54 |
|
55 | 55 | # General information about the project. |
56 | | -project = u'netjsonconfig' |
57 | | -copyright = u'{0}, OpenWISP.org'.format(datetime.date.today().year) |
58 | | -author = u'Federico Capoano' |
| 56 | +project = "netjsonconfig" |
| 57 | +copyright = "{0}, OpenWISP.org".format(datetime.date.today().year) |
| 58 | +author = "Federico Capoano" |
59 | 59 |
|
60 | 60 | # The version info for the project you're documenting, acts as replacement for |
61 | 61 | # |version| and |release|, also used in various other places throughout the |
62 | 62 | # built documents. |
63 | 63 | # |
64 | 64 | # The short X.Y version. |
65 | | -version = '{0}.{1}'.format(VERSION[0], VERSION[1]) |
| 65 | +version = "{0}.{1}".format(VERSION[0], VERSION[1]) |
66 | 66 | # The full version, including alpha/beta/rc tags. |
67 | 67 | release = get_version() |
68 | 68 |
|
|
71 | 71 | # |
72 | 72 | # This is also used if you do content translation via gettext catalogs. |
73 | 73 | # Usually you set "language" from the command line for these cases. |
74 | | -language = 'en' |
| 74 | +language = "en" |
75 | 75 |
|
76 | 76 | # There are two options for replacing |today|: either, you set today to some |
77 | 77 | # non-false value, then it is used: |
|
99 | 99 | # show_authors = False |
100 | 100 |
|
101 | 101 | # The name of the Pygments (syntax highlighting) style to use. |
102 | | -pygments_style = 'sphinx' |
| 102 | +pygments_style = "sphinx" |
103 | 103 |
|
104 | 104 | # A list of ignored prefixes for module index sorting. |
105 | 105 | # modindex_common_prefix = [] |
|
115 | 115 |
|
116 | 116 | # The theme to use for HTML and HTML Help pages. See the documentation for |
117 | 117 | # a list of builtin themes. |
118 | | -html_theme = 'openwisp-sphinx-theme' |
119 | | -html_favicon = 'assets/design/favicon.png' |
120 | | -html_logo = 'assets/design/netjson-logo-dark.png' |
| 118 | +html_theme = "openwisp-sphinx-theme" |
| 119 | +html_favicon = "assets/design/favicon.png" |
| 120 | +html_logo = "assets/design/netjson-logo-dark.png" |
121 | 121 |
|
122 | 122 | # Theme options are theme-specific and customize the look and feel of a theme |
123 | 123 | # further. For a list of options available for each theme, see the |
|
209 | 209 | # html_search_scorer = 'scorer.js' |
210 | 210 |
|
211 | 211 | # Output file base name for HTML help builder. |
212 | | -htmlhelp_basename = 'netjsonconfigdoc' |
| 212 | +htmlhelp_basename = "netjsonconfigdoc" |
213 | 213 |
|
214 | 214 | # -- Options for manual page output --------------------------------------- |
215 | 215 |
|
216 | 216 | # One entry per manual page. List of tuples |
217 | 217 | # (source start file, name, description, authors, manual section). |
218 | | -man_pages = [(master_doc, 'netjsonconfig', u'netjsonconfig Documentation', [author], 1)] |
| 218 | +man_pages = [(master_doc, "netjsonconfig", "netjsonconfig Documentation", [author], 1)] |
219 | 219 |
|
220 | 220 | # If true, show URL addresses after external links. |
221 | 221 | # man_show_urls = False |
|
229 | 229 | texinfo_documents = [ |
230 | 230 | ( |
231 | 231 | master_doc, |
232 | | - 'netjsonconfig', |
233 | | - u'netjsonconfig documentation', |
| 232 | + "netjsonconfig", |
| 233 | + "netjsonconfig documentation", |
234 | 234 | author, |
235 | | - 'netjsonconfig', |
236 | | - 'Python library that converts NetJSON DeviceConfiguration objects to real router configurations.', |
237 | | - 'Miscellaneous', |
| 235 | + "netjsonconfig", |
| 236 | + "Python library that converts NetJSON DeviceConfiguration objects to real router configurations.", |
| 237 | + "Miscellaneous", |
238 | 238 | ), |
239 | 239 | ] |
240 | 240 |
|
|
297 | 297 | # epub_post_files = [] |
298 | 298 |
|
299 | 299 | # A list of files that should not be packed into the epub file. |
300 | | -epub_exclude_files = ['search.html'] |
| 300 | +epub_exclude_files = ["search.html"] |
301 | 301 |
|
302 | 302 | # The depth of the table of contents in toc.ncx. |
303 | 303 | # epub_tocdepth = 3 |
|
0 commit comments