|
10 | 10 | import os
|
11 | 11 | import sys
|
12 | 12 |
|
13 |
| -sys.path.insert(0, os.path.abspath('.')) |
14 |
| -sys.path.insert(0, os.path.abspath('..')) |
| 13 | +sys.path.insert(0, os.path.abspath(".")) |
| 14 | +sys.path.insert(0, os.path.abspath("..")) |
15 | 15 |
|
16 | 16 | ##################################################
|
17 | 17 | # Project Information
|
18 | 18 | ##################################################
|
19 |
| -project = 'docstr_coverage' |
20 |
| -copyright = '2018, Hunter McGushion' |
21 |
| -author = 'Hunter McGushion' |
| 19 | +project = "docstr_coverage" |
| 20 | +copyright = "2018, Hunter McGushion" |
| 21 | +author = "Hunter McGushion" |
22 | 22 |
|
23 |
| -version = '' # The short X.Y version |
24 |
| -release = '1.0.1' # The full version, including alpha/beta/rc tags |
| 23 | +version = "" # The short X.Y version |
| 24 | +release = "1.0.2" # The full version, including alpha/beta/rc tags |
25 | 25 |
|
26 | 26 | ##################################################
|
27 | 27 | # General Configuration
|
|
32 | 32 | # Add any Sphinx extension module names here, as strings. They can be
|
33 | 33 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
34 | 34 | extensions = [
|
35 |
| - 'sphinx.ext.autodoc', |
36 |
| - 'sphinx.ext.coverage', |
37 |
| - 'sphinx.ext.viewcode', |
38 |
| - 'sphinx.ext.githubpages', |
39 |
| - 'sphinx.ext.napoleon', |
| 35 | + "sphinx.ext.autodoc", |
| 36 | + "sphinx.ext.coverage", |
| 37 | + "sphinx.ext.viewcode", |
| 38 | + "sphinx.ext.githubpages", |
| 39 | + "sphinx.ext.napoleon", |
40 | 40 | ]
|
41 | 41 |
|
42 | 42 | # Add any paths that contain templates here, relative to this directory.
|
43 |
| -templates_path = ['_templates'] |
| 43 | +templates_path = ["_templates"] |
44 | 44 |
|
45 | 45 | # The suffix(es) of source filenames. You can specify multiple suffix as a list of string: `source_suffix = ['.rst', '.md']`
|
46 |
| -source_suffix = '.rst' |
| 46 | +source_suffix = ".rst" |
47 | 47 |
|
48 | 48 | # The master toctree document.
|
49 |
| -master_doc = 'index' |
| 49 | +master_doc = "index" |
50 | 50 |
|
51 | 51 | # The language for content autogenerated by Sphinx. Refer to documentation for a list of supported languages. This is also used
|
52 | 52 | # if you do content translation via gettext catalogs. Usually you set "language" from the command line for these cases.
|
53 | 53 | language = None
|
54 | 54 |
|
55 | 55 | # List of patterns, relative to source directory, that match files and directories to ignore when looking for source files.
|
56 | 56 | # This pattern also affects html_static_path and html_extra_path.
|
57 |
| -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 57 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
58 | 58 |
|
59 | 59 | # The name of the Pygments (syntax highlighting) style to use.
|
60 |
| -pygments_style = 'sphinx' |
| 60 | +pygments_style = "sphinx" |
61 | 61 |
|
62 | 62 | ##################################################
|
63 | 63 | # AutoDocumentation/Napoleon Settings
|
|
69 | 69 | # Options for HTML Output
|
70 | 70 | ##################################################
|
71 | 71 | # The theme to use for HTML and HTML Help pages. See the documentation for a list of builtin themes.
|
72 |
| -html_theme = 'sphinx_rtd_theme' # 'nature' |
| 72 | +html_theme = "sphinx_rtd_theme" # 'nature' |
73 | 73 |
|
74 | 74 | # Theme options are theme-specific and customize the look and feel of a theme further. For a list of options available for each
|
75 | 75 | # theme, see the documentation.
|
76 | 76 | # html_theme_options = {}
|
77 | 77 |
|
78 | 78 | # Add any paths that contain custom static files (such as style sheets) here, relative to this directory. They are copied after
|
79 | 79 | # the builtin static files, so a file named "default.css" will overwrite the builtin "default.css".
|
80 |
| -html_static_path = ['_static'] |
81 |
| -modindex_common_prefix = ['docstr_coverage.'] |
| 80 | +html_static_path = ["_static"] |
| 81 | +modindex_common_prefix = ["docstr_coverage."] |
82 | 82 |
|
83 | 83 | # Custom sidebar templates, must be a dictionary that maps document names to template names. The default sidebars (for documents
|
84 | 84 | # that don't match any pattern) are defined by theme itself. Builtin themes are using these templates by default:
|
|
89 | 89 | # Options for HTMLHelp Output
|
90 | 90 | ##################################################
|
91 | 91 | # Output file base name for HTML help builder.
|
92 |
| -htmlhelp_basename = 'docstr_coveragedoc' |
| 92 | +htmlhelp_basename = "docstr_coveragedoc" |
93 | 93 |
|
94 | 94 | ##################################################
|
95 | 95 | # Options for LaTeX Output
|
|
103 | 103 |
|
104 | 104 | # Grouping the document tree into LaTeX files. List of tuples:
|
105 | 105 | # (source start file, target name, title, author, documentclass [howto, manual, or own class]).
|
106 |
| -latex_documents = [(master_doc, 'docstr_coverage.tex', 'docstr\\_coverage Documentation', 'Hunter McGushion', 'manual')] |
| 106 | +latex_documents = [ |
| 107 | + ( |
| 108 | + master_doc, |
| 109 | + "docstr_coverage.tex", |
| 110 | + "docstr\\_coverage Documentation", |
| 111 | + "Hunter McGushion", |
| 112 | + "manual", |
| 113 | + ) |
| 114 | +] |
107 | 115 |
|
108 | 116 | ##################################################
|
109 | 117 | # Options for Manual Page Output
|
110 | 118 | ##################################################
|
111 | 119 | # One entry per manual page. List of tuples: (source start file, name, description, authors, manual section).
|
112 |
| -man_pages = [(master_doc, 'docstr_coverage', 'docstr_coverage Documentation', [author], 1)] |
| 120 | +man_pages = [(master_doc, "docstr_coverage", "docstr_coverage Documentation", [author], 1)] |
113 | 121 |
|
114 | 122 | ##################################################
|
115 | 123 | # Options for Texinfo Output
|
|
118 | 126 | # (source start file, target name, title, author, dir menu entry, description, category)
|
119 | 127 | texinfo_documents = [
|
120 | 128 | (
|
121 |
| - master_doc, 'docstr_coverage', 'docstr_coverage Documentation', |
122 |
| - author, 'docstr_coverage', 'One line description of project.', 'Miscellaneous' |
123 |
| - ), |
| 129 | + master_doc, |
| 130 | + "docstr_coverage", |
| 131 | + "docstr_coverage Documentation", |
| 132 | + author, |
| 133 | + "docstr_coverage", |
| 134 | + "One line description of project.", |
| 135 | + "Miscellaneous", |
| 136 | + ) |
124 | 137 | ]
|
125 | 138 |
|
126 | 139 | ##################################################
|
|
0 commit comments