|
14 | 14 | # If extensions (or modules to document with autodoc) are in another directory, |
15 | 15 | # add these directories to sys.path here. If the directory is relative to the |
16 | 16 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
17 | | -sys.path.insert(0, os.path.abspath('...')) |
18 | | -sys.path.insert(0, os.path.abspath('..')) |
19 | | -sys.path.insert(0, os.path.abspath('.')) |
| 17 | +sys.path.insert(0, os.path.abspath("...")) |
| 18 | +sys.path.insert(0, os.path.abspath("..")) |
| 19 | +sys.path.insert(0, os.path.abspath(".")) |
20 | 20 |
|
21 | 21 | # -- General configuration --------------------------------------------------- |
22 | 22 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
23 | 23 |
|
24 | 24 | extensions = [ |
25 | | - 'sphinx.ext.autodoc', |
26 | | - 'sphinx.ext.githubpages', |
27 | | - 'sphinx.ext.intersphinx', |
28 | | - 'sphinx.ext.napoleon', |
29 | | - 'sphinx.ext.viewcode', |
30 | | - 'sphinx_copybutton', |
31 | | - 'sphinxcontrib.typer', |
32 | | - 'sphinxext.opengraph', |
33 | | - 'myst_parser', |
| 25 | + "sphinx.ext.autodoc", |
| 26 | + "sphinx.ext.githubpages", |
| 27 | + "sphinx.ext.intersphinx", |
| 28 | + "sphinx.ext.napoleon", |
| 29 | + "sphinx.ext.viewcode", |
| 30 | + "sphinx_copybutton", |
| 31 | + "sphinxcontrib.typer", |
| 32 | + "sphinxext.opengraph", |
| 33 | + "myst_parser", |
34 | 34 | ] |
35 | 35 |
|
36 | 36 | myst_enable_extensions = [ |
37 | | - 'colon_fence', |
38 | | - 'fieldlist', |
39 | | - 'replacements', |
40 | | - 'tasklist', |
| 37 | + "colon_fence", |
| 38 | + "fieldlist", |
| 39 | + "replacements", |
| 40 | + "tasklist", |
41 | 41 | ] |
42 | 42 |
|
43 | 43 | # Settings from the copybutton's config |
44 | 44 | # https://github.com/executablebooks/sphinx-copybutton/blob/master/docs/conf.py |
45 | 45 | # There are useful for ensuring that the copy button only copies code |
46 | 46 | # (as prefixed by ">>>" for example) and not the prompt or the output. |
47 | | -copybutton_prompt_text = r'>>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: ' |
| 47 | +copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " |
48 | 48 | copybutton_prompt_is_regexp = True |
49 | | -copybutton_line_continuation_character = '\\' |
50 | | -copybutton_here_doc_delimiter = 'EOT' |
51 | | -copybutton_selector = 'div:not(.no-copybutton) > div.highlight > pre' |
| 49 | +copybutton_line_continuation_character = "\\" |
| 50 | +copybutton_here_doc_delimiter = "EOT" |
| 51 | +copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre" |
52 | 52 |
|
53 | 53 | # Open graph settings |
54 | | -ogp_site_url = 'https://bsweger.github.io/pyprefab/' |
55 | | -ogp_image = 'https://bsweger.github.io/pyprefab/_static/pyprefab.png' |
| 54 | +ogp_site_url = "https://bsweger.github.io/pyprefab/" |
| 55 | +ogp_image = "https://bsweger.github.io/pyprefab/_static/pyprefab.png" |
56 | 56 |
|
57 | | -templates_path = ['_templates'] |
| 57 | +templates_path = ["_templates"] |
58 | 58 | exclude_patterns = [] |
59 | 59 |
|
60 | 60 | # The suffix(es) of source filenames. |
61 | 61 | # You can specify multiple suffix as a list of string: |
62 | | -source_suffix = ['.rst', '.md'] |
| 62 | +source_suffix = [".rst", ".md"] |
63 | 63 |
|
64 | 64 | # The encoding of source files. |
65 | 65 | # source_encoding = 'utf-8-sig' |
66 | 66 |
|
67 | 67 | # The master toctree document. |
68 | | -master_doc = 'index' |
| 68 | +master_doc = "index" |
69 | 69 |
|
70 | 70 | # project information |
71 | 71 | now = datetime.now() |
72 | | -project = 'pyprefab' |
| 72 | +project = "pyprefab" |
73 | 73 | copyright = f'{now.year}, Becky Sweger | Last update {now.strftime("%B %d, %Y")}' |
74 | | -author = 'Becky Sweger' |
| 74 | +author = "Becky Sweger" |
75 | 75 |
|
76 | | -version = metadata.version('pyprefab') |
| 76 | +version = metadata.version("pyprefab") |
77 | 77 | release = version |
78 | 78 |
|
79 | 79 | # The language for content autogenerated by Sphinx. Refer to documentation |
80 | 80 | # for a list of supported languages. |
81 | | -language = 'en' |
| 81 | +language = "en" |
82 | 82 |
|
83 | 83 | # List of patterns, relative to source directory, that match files and |
84 | 84 | # directories to ignore when looking for source files. |
85 | | -exclude_patterns = ['_build'] |
| 85 | +exclude_patterns = ["_build"] |
86 | 86 |
|
87 | 87 | # The name of the Pygments (syntax highlighting) style to use. |
88 | | -pygments_style = 'monokai' |
| 88 | +pygments_style = "monokai" |
89 | 89 |
|
90 | 90 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
91 | 91 | todo_include_todos = False |
|
94 | 94 | # -- Options for HTML output ------------------------------------------------- |
95 | 95 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
96 | 96 |
|
97 | | -html_theme = 'alabaster' |
98 | | -html_static_path = ['_static'] |
| 97 | +html_theme = "alabaster" |
| 98 | +html_static_path = ["_static"] |
99 | 99 |
|
100 | 100 | # Theme options are theme-specific and customize the look and feel of a theme |
101 | 101 | # further. For a list of options available for each theme, see the |
102 | 102 | # documentation. |
103 | 103 | html_theme_options = { |
104 | | - 'description': f'Small CLI for Python project scaffolding\n{release}', |
105 | | - 'github_user': 'bsweger', |
106 | | - 'github_repo': 'pyprefab', |
107 | | - 'github_banner': True, |
108 | | - 'github_button': False, |
109 | | - 'font_family': "'Roboto', Georgia, sans", |
110 | | - 'head_font_family': "'Roboto', Georgia, serif", |
111 | | - 'code_font_family': "'Roboto Mono', 'Consolas', monospace", |
112 | | - 'pre_bg': '#433e56', |
| 104 | + "description": f"Small CLI for Python project scaffolding\n{release}", |
| 105 | + "github_user": "bsweger", |
| 106 | + "github_repo": "pyprefab", |
| 107 | + "github_banner": True, |
| 108 | + "github_button": False, |
| 109 | + "font_family": "'Roboto', Georgia, sans", |
| 110 | + "head_font_family": "'Roboto', Georgia, serif", |
| 111 | + "code_font_family": "'Roboto Mono', 'Consolas', monospace", |
| 112 | + "pre_bg": "#433e56", |
113 | 113 | } |
114 | 114 |
|
115 | 115 | # Add any paths that contain custom themes here, relative to this directory. |
|
134 | 134 | # Add any paths that contain custom static files (such as style sheets) here, |
135 | 135 | # relative to this directory. They are copied after the builtin static files, |
136 | 136 | # so a file named "default.css" will overwrite the builtin "default.css". |
137 | | -html_static_path = ['_static'] |
| 137 | +html_static_path = ["_static"] |
138 | 138 |
|
139 | 139 | # These paths are either relative to html_static_path |
140 | 140 | # or fully qualified paths (eg. https://...) |
141 | 141 | html_css_files = [ |
142 | | - 'custom.css', |
| 142 | + "custom.css", |
143 | 143 | ] |
144 | 144 |
|
145 | 145 | # Add any extra paths that contain custom files (such as robots.txt or |
|
149 | 149 |
|
150 | 150 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
151 | 151 | # using the given strftime format. |
152 | | -html_last_updated_fmt = '%b %d, %Y' |
| 152 | +html_last_updated_fmt = "%b %d, %Y" |
153 | 153 |
|
154 | 154 | # If true, SmartyPants will be used to convert quotes and dashes to |
155 | 155 | # typographically correct entities. |
|
0 commit comments