Skip to content

Commit 134887b

Browse files
set language, autoformat
1 parent ecd8634 commit 134887b

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

docs/conf.py

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
# sys.path.insert(0, os.path.abspath('.'))
1818
import os
1919
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__), "..")))
2122
from asyncstdlib import __version__
2223

2324

@@ -43,37 +44,37 @@
4344
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
4445
# ones.
4546
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",
5253
]
5354

5455
# Add any paths that contain templates here, relative to this directory.
55-
templates_path = ['_templates']
56+
templates_path = ["_templates"]
5657

5758
# The suffix(es) of source filenames.
5859
# You can specify multiple suffix as a list of string:
5960
#
6061
# source_suffix = ['.rst', '.md']
61-
source_suffix = '.rst'
62+
source_suffix = ".rst"
6263

6364
# The master toctree document.
64-
master_doc = 'index'
65+
master_doc = "index"
6566

6667
# The language for content autogenerated by Sphinx. Refer to documentation
6768
# for a list of supported languages.
6869
#
6970
# This is also used if you do content translation via gettext catalogs.
7071
# Usually you set "language" from the command line for these cases.
71-
language = None
72+
language = "en"
7273

7374
# List of patterns, relative to source directory, that match files and
7475
# directories to ignore when looking for source files.
7576
# 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"]
7778

7879
# The name of the Pygments (syntax highlighting) style to use.
7980
pygments_style = None
@@ -87,23 +88,23 @@
8788
# The theme to use for HTML and HTML Help pages. See the documentation for
8889
# a list of builtin themes.
8990
#
90-
html_theme = 'alabaster'
91+
html_theme = "alabaster"
9192

9293
# Theme options are theme-specific and customize the look and feel of a theme
9394
# further. For a list of options available for each theme, see the
9495
# documentation.
9596
#
9697
html_theme_options = {
9798
"description": "The missing async toolbox",
98-
'github_user': 'maxfischer2781',
99-
'github_repo': 'asyncstdlib',
99+
"github_user": "maxfischer2781",
100+
"github_repo": "asyncstdlib",
100101
"fixed_sidebar": True,
101102
}
102103

103104
# Add any paths that contain custom static files (such as style sheets) here,
104105
# relative to this directory. They are copied after the builtin static files,
105106
# so a file named "default.css" will overwrite the builtin "default.css".
106-
html_static_path = ['_static']
107+
html_static_path = ["_static"]
107108

108109
# Custom sidebar templates, must be a dictionary that maps document names
109110
# to template names.
@@ -119,17 +120,17 @@
119120
# -- Options for HTMLHelp output ---------------------------------------------
120121

121122
# Output file base name for HTML help builder.
122-
htmlhelp_basename = 'asyncstdlibdoc'
123+
htmlhelp_basename = "asyncstdlibdoc"
123124

124125
# -- Extension configuration -------------------------------------------------
125126

126127
# -- Options for intersphinx extension ---------------------------------------
127128

128129
# Example configuration for intersphinx: refer to the Python standard library.
129130
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),
133134
}
134135

135136
# -- Options for todo extension ----------------------------------------------
@@ -141,4 +142,5 @@
141142

142143
# disable overload detection – conflicts with manual/steno signatures
143144
from sphinx.pycode.parser import VariableCommentPicker
145+
144146
VariableCommentPicker.add_overload_entry = lambda self, *args, **kwargs: ()

0 commit comments

Comments
 (0)