|
21 | 21 |
|
22 | 22 | import git_stacktrace
|
23 | 23 |
|
24 |
| -sys.path.insert(0, os.path.abspath('.')) |
| 24 | +sys.path.insert(0, os.path.abspath(".")) |
25 | 25 |
|
26 | 26 |
|
27 | 27 | # -- General configuration ------------------------------------------------
|
|
33 | 33 | # Add any Sphinx extension module names here, as strings. They can be
|
34 | 34 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
35 | 35 | # ones.
|
36 |
| -extensions = [ |
37 |
| - 'sphinx.ext.autodoc', |
38 |
| - 'sphinx.ext.viewcode', |
39 |
| - 'sphinx.ext.intersphinx'] |
| 36 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.intersphinx"] |
40 | 37 |
|
41 | 38 | # Add any paths that contain templates here, relative to this directory.
|
42 |
| -templates_path = ['_templates'] |
| 39 | +templates_path = ["_templates"] |
43 | 40 |
|
44 | 41 | # The suffix(es) of source filenames.
|
45 | 42 | # You can specify multiple suffix as a list of string:
|
46 | 43 | #
|
47 | 44 | # source_suffix = ['.rst', '.md']
|
48 |
| -source_suffix = '.rst' |
| 45 | +source_suffix = ".rst" |
49 | 46 |
|
50 | 47 | # The master toctree document.
|
51 |
| -master_doc = 'index' |
| 48 | +master_doc = "index" |
52 | 49 |
|
53 | 50 | # General information about the project.
|
54 |
| -project = u'git-stacktrace' |
55 |
| -copyright = u'2017 Pinterest, Inc' |
56 |
| -author = u'Joe Gordon' |
| 51 | +project = u"git-stacktrace" |
| 52 | +copyright = u"2017 Pinterest, Inc" |
| 53 | +author = u"Joe Gordon" |
57 | 54 |
|
58 | 55 |
|
59 | 56 | # The version info for the project you're documenting, acts as replacement for
|
|
78 | 75 | exclude_patterns = []
|
79 | 76 |
|
80 | 77 | # The name of the Pygments (syntax highlighting) style to use.
|
81 |
| -pygments_style = 'sphinx' |
| 78 | +pygments_style = "sphinx" |
82 | 79 |
|
83 | 80 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
84 | 81 | todo_include_todos = False
|
|
89 | 86 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
90 | 87 | # a list of builtin themes.
|
91 | 88 | #
|
92 |
| -html_theme = 'sphinx_rtd_theme' |
| 89 | +html_theme = "sphinx_rtd_theme" |
93 | 90 |
|
94 | 91 | # Theme options are theme-specific and customize the look and feel of a theme
|
95 | 92 | # further. For a list of options available for each theme, see the
|
|
100 | 97 | # Add any paths that contain custom static files (such as style sheets) here,
|
101 | 98 | # relative to this directory. They are copied after the builtin static files,
|
102 | 99 | # so a file named "default.css" will overwrite the builtin "default.css".
|
103 |
| -html_static_path = ['_static'] |
| 100 | +html_static_path = ["_static"] |
104 | 101 |
|
105 | 102 | # Custom sidebar templates, must be a dictionary that maps document names
|
106 | 103 | # to template names.
|
107 | 104 | #
|
108 | 105 | # This is required for the alabaster theme
|
109 | 106 | # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
110 | 107 | html_sidebars = {
|
111 |
| - '**': [ |
112 |
| - 'about.html', |
113 |
| - 'navigation.html', |
114 |
| - 'relations.html', # needs 'show_related': True theme option to display |
115 |
| - 'searchbox.html', |
116 |
| - 'donate.html', |
| 108 | + "**": [ |
| 109 | + "about.html", |
| 110 | + "navigation.html", |
| 111 | + "relations.html", # needs 'show_related': True theme option to display |
| 112 | + "searchbox.html", |
| 113 | + "donate.html", |
117 | 114 | ]
|
118 | 115 | }
|
119 | 116 |
|
120 | 117 |
|
121 | 118 | # -- Options for HTMLHelp output ------------------------------------------
|
122 | 119 |
|
123 | 120 | # Output file base name for HTML help builder.
|
124 |
| -htmlhelp_basename = 'git-stacktracedoc' |
| 121 | +htmlhelp_basename = "git-stacktracedoc" |
125 | 122 |
|
126 | 123 |
|
127 | 124 | # -- Options for LaTeX output ---------------------------------------------
|
|
130 | 127 | # The paper size ('letterpaper' or 'a4paper').
|
131 | 128 | #
|
132 | 129 | # 'papersize': 'letterpaper',
|
133 |
| - |
134 | 130 | # The font size ('10pt', '11pt' or '12pt').
|
135 | 131 | #
|
136 | 132 | # 'pointsize': '10pt',
|
137 |
| - |
138 | 133 | # Additional stuff for the LaTeX preamble.
|
139 | 134 | #
|
140 | 135 | # 'preamble': '',
|
141 |
| - |
142 | 136 | # Latex figure (float) alignment
|
143 | 137 | #
|
144 | 138 | # 'figure_align': 'htbp',
|
|
148 | 142 | # (source start file, target name, title,
|
149 | 143 | # author, documentclass [howto, manual, or own class]).
|
150 | 144 | latex_documents = [
|
151 |
| - (master_doc, 'git-stacktrace.tex', u'git-stacktrace Documentation', |
152 |
| - u'Joe Gordon', 'manual'), |
| 145 | + (master_doc, "git-stacktrace.tex", u"git-stacktrace Documentation", u"Joe Gordon", "manual"), |
153 | 146 | ]
|
154 | 147 |
|
155 | 148 |
|
156 | 149 | # -- Options for manual page output ---------------------------------------
|
157 | 150 |
|
158 | 151 | # One entry per manual page. List of tuples
|
159 | 152 | # (source start file, name, description, authors, manual section).
|
160 |
| -man_pages = [ |
161 |
| - (master_doc, 'git-stacktrace', u'git-stacktrace Documentation', |
162 |
| - [author], 1) |
163 |
| -] |
| 153 | +man_pages = [(master_doc, "git-stacktrace", u"git-stacktrace Documentation", [author], 1)] |
164 | 154 |
|
165 | 155 |
|
166 | 156 | # -- Options for Texinfo output -------------------------------------------
|
|
169 | 159 | # (source start file, target name, title, author,
|
170 | 160 | # dir menu entry, description, category)
|
171 | 161 | texinfo_documents = [
|
172 |
| - (master_doc, 'git-stacktrace', u'git-stacktrace Documentation', |
173 |
| - author, 'git-stacktrace', 'One line description of project.', |
174 |
| - 'Miscellaneous'), |
| 162 | + ( |
| 163 | + master_doc, |
| 164 | + "git-stacktrace", |
| 165 | + u"git-stacktrace Documentation", |
| 166 | + author, |
| 167 | + "git-stacktrace", |
| 168 | + "One line description of project.", |
| 169 | + "Miscellaneous", |
| 170 | + ), |
175 | 171 | ]
|
176 | 172 |
|
177 | 173 |
|
178 | 174 | # Example configuration for intersphinx: refer to the Python standard library.
|
179 |
| -intersphinx_mapping = {'https://docs.python.org/': None} |
| 175 | +intersphinx_mapping = {"https://docs.python.org/": None} |
0 commit comments