|
31 | 31 | # Add any Sphinx extension module names here, as strings. They can be |
32 | 32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
33 | 33 | # ones. |
34 | | -extensions = ['sphinx.ext.autodoc', |
35 | | - 'sphinx.ext.intersphinx', |
36 | | - 'sphinx.ext.coverage', |
37 | | - 'sphinx.ext.viewcode'] |
| 34 | +extensions = [ |
| 35 | + "sphinx.ext.autodoc", |
| 36 | + "sphinx.ext.intersphinx", |
| 37 | + "sphinx.ext.coverage", |
| 38 | + "sphinx.ext.viewcode", |
| 39 | +] |
38 | 40 |
|
39 | 41 | # Add any paths that contain templates here, relative to this directory. |
40 | | -templates_path = ['_templates'] |
| 42 | +templates_path = ["_templates"] |
41 | 43 |
|
42 | 44 | # The suffix(es) of source filenames. |
43 | 45 | # You can specify multiple suffix as a list of string: |
44 | 46 | # |
45 | 47 | # source_suffix = ['.rst', '.md'] |
46 | | -source_suffix = '.rst' |
| 48 | +source_suffix = ".rst" |
47 | 49 |
|
48 | 50 | # The master toctree document. |
49 | | -master_doc = 'index' |
| 51 | +master_doc = "index" |
50 | 52 |
|
51 | 53 | # General information about the project. |
52 | | -project = 'CryptoJWT' |
53 | | -copyright = '2018, Roland Hedberg' |
54 | | -author = 'Roland Hedberg' |
| 54 | +project = "CryptoJWT" |
| 55 | +copyright = "2018, Roland Hedberg" |
| 56 | +author = "Roland Hedberg" |
55 | 57 |
|
56 | 58 | # The version info for the project you're documenting, acts as replacement for |
57 | 59 | # |version| and |release|, also used in various other places throughout the |
58 | 60 | # built documents. |
59 | 61 | # |
60 | 62 | # The short X.Y version. |
61 | | -version = '0.4' |
| 63 | +version = "0.4" |
62 | 64 | # The full version, including alpha/beta/rc tags. |
63 | | -release = '0.4' |
| 65 | +release = "0.4" |
64 | 66 |
|
65 | 67 | # The language for content autogenerated by Sphinx. Refer to documentation |
66 | 68 | # for a list of supported languages. |
|
72 | 74 | # List of patterns, relative to source directory, that match files and |
73 | 75 | # directories to ignore when looking for source files. |
74 | 76 | # This patterns also effect to html_static_path and html_extra_path |
75 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 77 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
76 | 78 |
|
77 | 79 | # The name of the Pygments (syntax highlighting) style to use. |
78 | | -pygments_style = 'sphinx' |
| 80 | +pygments_style = "sphinx" |
79 | 81 |
|
80 | 82 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
81 | 83 | todo_include_todos = False |
|
86 | 88 | # The theme to use for HTML and HTML Help pages. See the documentation for |
87 | 89 | # a list of builtin themes. |
88 | 90 | # |
89 | | -html_theme = 'default' |
| 91 | +html_theme = "default" |
90 | 92 |
|
91 | 93 | # Theme options are theme-specific and customize the look and feel of a theme |
92 | 94 | # further. For a list of options available for each theme, see the |
|
97 | 99 | # Add any paths that contain custom static files (such as style sheets) here, |
98 | 100 | # relative to this directory. They are copied after the builtin static files, |
99 | 101 | # so a file named "default.css" will overwrite the builtin "default.css". |
100 | | -html_static_path = ['_static'] |
| 102 | +html_static_path = ["_static"] |
101 | 103 |
|
102 | 104 | # Custom sidebar templates, must be a dictionary that maps document names |
103 | 105 | # to template names. |
104 | 106 | # |
105 | 107 | # This is required for the alabaster theme |
106 | 108 | # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars |
107 | 109 | html_sidebars = { |
108 | | - '**': [ |
109 | | - 'relations.html', # needs 'show_related': True theme option to display |
110 | | - 'searchbox.html', |
| 110 | + "**": [ |
| 111 | + "relations.html", # needs 'show_related': True theme option to display |
| 112 | + "searchbox.html", |
111 | 113 | ] |
112 | 114 | } |
113 | 115 |
|
114 | 116 |
|
115 | 117 | # -- Options for HTMLHelp output ------------------------------------------ |
116 | 118 |
|
117 | 119 | # Output file base name for HTML help builder. |
118 | | -htmlhelp_basename = 'CryptoJWTdoc' |
| 120 | +htmlhelp_basename = "CryptoJWTdoc" |
119 | 121 |
|
120 | 122 |
|
121 | 123 | # -- Options for LaTeX output --------------------------------------------- |
|
124 | 126 | # The paper size ('letterpaper' or 'a4paper'). |
125 | 127 | # |
126 | 128 | # 'papersize': 'letterpaper', |
127 | | - |
128 | 129 | # The font size ('10pt', '11pt' or '12pt'). |
129 | 130 | # |
130 | 131 | # 'pointsize': '10pt', |
131 | | - |
132 | 132 | # Additional stuff for the LaTeX preamble. |
133 | 133 | # |
134 | 134 | # 'preamble': '', |
135 | | - |
136 | 135 | # Latex figure (float) alignment |
137 | 136 | # |
138 | 137 | # 'figure_align': 'htbp', |
|
142 | 141 | # (source start file, target name, title, |
143 | 142 | # author, documentclass [howto, manual, or own class]). |
144 | 143 | latex_documents = [ |
145 | | - (master_doc, 'CryptoJWT.tex', 'CryptoJWT Documentation', |
146 | | - 'Roland Hedberg', 'manual'), |
| 144 | + (master_doc, "CryptoJWT.tex", "CryptoJWT Documentation", "Roland Hedberg", "manual"), |
147 | 145 | ] |
148 | 146 |
|
149 | 147 |
|
150 | 148 | # -- Options for manual page output --------------------------------------- |
151 | 149 |
|
152 | 150 | # One entry per manual page. List of tuples |
153 | 151 | # (source start file, name, description, authors, manual section). |
154 | | -man_pages = [ |
155 | | - (master_doc, 'cryptojwt', 'CryptoJWT Documentation', |
156 | | - [author], 1) |
157 | | -] |
| 152 | +man_pages = [(master_doc, "cryptojwt", "CryptoJWT Documentation", [author], 1)] |
158 | 153 |
|
159 | 154 |
|
160 | 155 | # -- Options for Texinfo output ------------------------------------------- |
|
163 | 158 | # (source start file, target name, title, author, |
164 | 159 | # dir menu entry, description, category) |
165 | 160 | texinfo_documents = [ |
166 | | - (master_doc, 'CryptoJWT', 'CryptoJWT Documentation', |
167 | | - author, 'CryptoJWT', 'One line description of project.', |
168 | | - 'Miscellaneous'), |
| 161 | + ( |
| 162 | + master_doc, |
| 163 | + "CryptoJWT", |
| 164 | + "CryptoJWT Documentation", |
| 165 | + author, |
| 166 | + "CryptoJWT", |
| 167 | + "One line description of project.", |
| 168 | + "Miscellaneous", |
| 169 | + ), |
169 | 170 | ] |
170 | 171 |
|
171 | 172 |
|
172 | | - |
173 | | - |
174 | 173 | # Example configuration for intersphinx: refer to the Python standard library. |
175 | | -intersphinx_mapping = {'https://docs.python.org/': None} |
| 174 | +intersphinx_mapping = {"https://docs.python.org/": None} |
0 commit comments