|
17 | 17 | # sys.path.insert(0, os.path.abspath('.')) |
18 | 18 | import os |
19 | 19 | import sys |
20 | | -sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) |
| 20 | + |
| 21 | +sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))) |
21 | 22 | from asyncstdlib import __version__ |
22 | 23 |
|
23 | 24 |
|
|
43 | 44 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
44 | 45 | # ones. |
45 | 46 | extensions = [ |
46 | | - 'sphinx.ext.autodoc', |
47 | | - 'sphinx.ext.intersphinx', |
48 | | - 'sphinx.ext.todo', |
49 | | - 'sphinx.ext.imgmath', |
50 | | - 'sphinx.ext.viewcode', |
51 | | - 'sphinxcontrib_trio', |
| 47 | + "sphinx.ext.autodoc", |
| 48 | + "sphinx.ext.intersphinx", |
| 49 | + "sphinx.ext.todo", |
| 50 | + "sphinx.ext.imgmath", |
| 51 | + "sphinx.ext.viewcode", |
| 52 | + "sphinxcontrib_trio", |
52 | 53 | ] |
53 | 54 |
|
54 | 55 | # Add any paths that contain templates here, relative to this directory. |
55 | | -templates_path = ['_templates'] |
| 56 | +templates_path = ["_templates"] |
56 | 57 |
|
57 | 58 | # The suffix(es) of source filenames. |
58 | 59 | # You can specify multiple suffix as a list of string: |
59 | 60 | # |
60 | 61 | # source_suffix = ['.rst', '.md'] |
61 | | -source_suffix = '.rst' |
| 62 | +source_suffix = ".rst" |
62 | 63 |
|
63 | 64 | # The master toctree document. |
64 | | -master_doc = 'index' |
| 65 | +master_doc = "index" |
65 | 66 |
|
66 | 67 | # The language for content autogenerated by Sphinx. Refer to documentation |
67 | 68 | # for a list of supported languages. |
68 | 69 | # |
69 | 70 | # This is also used if you do content translation via gettext catalogs. |
70 | 71 | # Usually you set "language" from the command line for these cases. |
71 | | -language = None |
| 72 | +language = "en" |
72 | 73 |
|
73 | 74 | # List of patterns, relative to source directory, that match files and |
74 | 75 | # directories to ignore when looking for source files. |
75 | 76 | # This pattern also affects html_static_path and html_extra_path. |
76 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 77 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
77 | 78 |
|
78 | 79 | # The name of the Pygments (syntax highlighting) style to use. |
79 | 80 | pygments_style = None |
|
87 | 88 | # The theme to use for HTML and HTML Help pages. See the documentation for |
88 | 89 | # a list of builtin themes. |
89 | 90 | # |
90 | | -html_theme = 'alabaster' |
| 91 | +html_theme = "alabaster" |
91 | 92 |
|
92 | 93 | # Theme options are theme-specific and customize the look and feel of a theme |
93 | 94 | # further. For a list of options available for each theme, see the |
94 | 95 | # documentation. |
95 | 96 | # |
96 | 97 | html_theme_options = { |
97 | 98 | "description": "The missing async toolbox", |
98 | | - 'github_user': 'maxfischer2781', |
99 | | - 'github_repo': 'asyncstdlib', |
| 99 | + "github_user": "maxfischer2781", |
| 100 | + "github_repo": "asyncstdlib", |
100 | 101 | "fixed_sidebar": True, |
101 | 102 | } |
102 | 103 |
|
103 | 104 | # Add any paths that contain custom static files (such as style sheets) here, |
104 | 105 | # relative to this directory. They are copied after the builtin static files, |
105 | 106 | # so a file named "default.css" will overwrite the builtin "default.css". |
106 | | -html_static_path = ['_static'] |
| 107 | +html_static_path = ["_static"] |
107 | 108 |
|
108 | 109 | # Custom sidebar templates, must be a dictionary that maps document names |
109 | 110 | # to template names. |
|
119 | 120 | # -- Options for HTMLHelp output --------------------------------------------- |
120 | 121 |
|
121 | 122 | # Output file base name for HTML help builder. |
122 | | -htmlhelp_basename = 'asyncstdlibdoc' |
| 123 | +htmlhelp_basename = "asyncstdlibdoc" |
123 | 124 |
|
124 | 125 | # -- Extension configuration ------------------------------------------------- |
125 | 126 |
|
126 | 127 | # -- Options for intersphinx extension --------------------------------------- |
127 | 128 |
|
128 | 129 | # Example configuration for intersphinx: refer to the Python standard library. |
129 | 130 | intersphinx_mapping = { |
130 | | - "python": ('https://docs.python.org/3', None), |
131 | | - "trio": ('https://trio.readthedocs.io/en/stable', None), |
132 | | - "simpy": ('https://simpy.readthedocs.io/en/stable', None), |
| 131 | + "python": ("https://docs.python.org/3", None), |
| 132 | + "trio": ("https://trio.readthedocs.io/en/stable", None), |
| 133 | + "simpy": ("https://simpy.readthedocs.io/en/stable", None), |
133 | 134 | } |
134 | 135 |
|
135 | 136 | # -- Options for todo extension ---------------------------------------------- |
|
141 | 142 |
|
142 | 143 | # disable overload detection – conflicts with manual/steno signatures |
143 | 144 | from sphinx.pycode.parser import VariableCommentPicker |
| 145 | + |
144 | 146 | VariableCommentPicker.add_overload_entry = lambda self, *args, **kwargs: () |
0 commit comments