|
21 | 21 | import os
|
22 | 22 | import sys
|
23 | 23 |
|
24 |
| -sys.path.insert(0, os.path.abspath('..')) |
| 24 | +sys.path.insert(0, os.path.abspath("..")) |
25 | 25 |
|
26 | 26 | import json2xml
|
27 | 27 |
|
|
35 | 35 |
|
36 | 36 | # Add any Sphinx extension module names here, as strings. They can be
|
37 | 37 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
38 |
| -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] |
| 38 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] |
39 | 39 |
|
40 | 40 | # Add any paths that contain templates here, relative to this directory.
|
41 |
| -templates_path = ['_templates'] |
| 41 | +templates_path = ["_templates"] |
42 | 42 |
|
43 | 43 | # The suffix(es) of source filenames.
|
44 | 44 | # You can specify multiple suffix as a list of string:
|
45 | 45 | #
|
46 | 46 | # source_suffix = ['.rst', '.md']
|
47 |
| -source_suffix = '.rst' |
| 47 | +source_suffix = ".rst" |
48 | 48 |
|
49 | 49 | # The master toctree document.
|
50 |
| -master_doc = 'index' |
| 50 | +master_doc = "index" |
51 | 51 |
|
52 | 52 | # General information about the project.
|
53 |
| -project = 'json2xml' |
54 |
| -copyright = f'{year}, Vinit Kumar' |
| 53 | +project = "json2xml" |
| 54 | +copyright = f"{year}, Vinit Kumar" |
55 | 55 | author = "Vinit Kumar"
|
56 | 56 |
|
57 | 57 | # The version info for the project you're documenting, acts as replacement
|
|
73 | 73 | # List of patterns, relative to source directory, that match files and
|
74 | 74 | # directories to ignore when looking for source files.
|
75 | 75 | # This patterns also effect to html_static_path and html_extra_path
|
76 |
| -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 76 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
77 | 77 |
|
78 | 78 | # The name of the Pygments (syntax highlighting) style to use.
|
79 |
| -pygments_style = 'sphinx' |
| 79 | +pygments_style = "sphinx" |
80 | 80 |
|
81 | 81 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
82 | 82 | todo_include_todos = False
|
|
87 | 87 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
88 | 88 | # a list of builtin themes.
|
89 | 89 | #
|
90 |
| -html_theme = 'furo' |
| 90 | +html_theme = "furo" |
91 | 91 |
|
92 | 92 | # Theme options are theme-specific and customize the look and feel of a
|
93 | 93 | # theme further. For a list of options available for each theme, see the
|
|
98 | 98 | # Add any paths that contain custom static files (such as style sheets) here,
|
99 | 99 | # relative to this directory. They are copied after the builtin static files,
|
100 | 100 | # so a file named "default.css" will overwrite the builtin "default.css".
|
101 |
| -html_static_path = ['_static'] |
| 101 | +html_static_path = ["_static"] |
102 | 102 |
|
103 | 103 |
|
104 | 104 | # -- Options for HTMLHelp output ---------------------------------------
|
105 | 105 |
|
106 | 106 | # Output file base name for HTML help builder.
|
107 |
| -htmlhelp_basename = 'json2xmldoc' |
| 107 | +htmlhelp_basename = "json2xmldoc" |
108 | 108 |
|
109 | 109 |
|
110 | 110 | # -- Options for LaTeX output ------------------------------------------
|
|
113 | 113 | # The paper size ('letterpaper' or 'a4paper').
|
114 | 114 | #
|
115 | 115 | # 'papersize': 'letterpaper',
|
116 |
| - |
117 | 116 | # The font size ('10pt', '11pt' or '12pt').
|
118 | 117 | #
|
119 | 118 | # 'pointsize': '10pt',
|
120 |
| - |
121 | 119 | # Additional stuff for the LaTeX preamble.
|
122 | 120 | #
|
123 | 121 | # 'preamble': '',
|
124 |
| - |
125 | 122 | # Latex figure (float) alignment
|
126 | 123 | #
|
127 | 124 | # 'figure_align': 'htbp',
|
|
131 | 128 | # (source start file, target name, title, author, documentclass
|
132 | 129 | # [howto, manual, or own class]).
|
133 | 130 | latex_documents = [
|
134 |
| - (master_doc, 'json2xml.tex', |
135 |
| - 'json2xml Documentation', |
136 |
| - 'Vinit Kumar', 'manual'), |
| 131 | + (master_doc, "json2xml.tex", "json2xml Documentation", "Vinit Kumar", "manual"), |
137 | 132 | ]
|
138 | 133 |
|
139 | 134 |
|
140 | 135 | # -- Options for manual page output ------------------------------------
|
141 | 136 |
|
142 | 137 | # One entry per manual page. List of tuples
|
143 | 138 | # (source start file, name, description, authors, manual section).
|
144 |
| -man_pages = [ |
145 |
| - (master_doc, 'json2xml', |
146 |
| - 'json2xml Documentation', |
147 |
| - [author], 1) |
148 |
| -] |
| 139 | +man_pages = [(master_doc, "json2xml", "json2xml Documentation", [author], 1)] |
149 | 140 |
|
150 | 141 |
|
151 | 142 | # -- Options for Texinfo output ----------------------------------------
|
|
154 | 145 | # (source start file, target name, title, author,
|
155 | 146 | # dir menu entry, description, category)
|
156 | 147 | texinfo_documents = [
|
157 |
| - (master_doc, 'json2xml', |
158 |
| - 'json2xml Documentation', |
159 |
| - author, |
160 |
| - 'json2xml', |
161 |
| - 'One line description of project.', |
162 |
| - 'Miscellaneous'), |
| 148 | + ( |
| 149 | + master_doc, |
| 150 | + "json2xml", |
| 151 | + "json2xml Documentation", |
| 152 | + author, |
| 153 | + "json2xml", |
| 154 | + "One line description of project.", |
| 155 | + "Miscellaneous", |
| 156 | + ), |
163 | 157 | ]
|
164 |
| - |
165 |
| - |
166 |
| - |
0 commit comments