Add language code for Sphinx

Author: Cito

docs/conf.py

@@ -30,29 +30,29 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
+    "sphinx.ext.autodoc",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 #
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'GraphQL-core 3'
-copyright = '2022, Christoph Zwerschke'
-author = 'Christoph Zwerschke'
+project = "GraphQL-core 3"
+copyright = "2022, Christoph Zwerschke"
+author = "Christoph Zwerschke"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -61,14 +61,14 @@
 # The short X.Y version.
 # version = '3.2'
 # The full version, including alpha/beta/rc tags.
-version = release = '3.2.3'
+version = release = "3.2.3"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -82,54 +82,62 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # AutoDoc configuration
 autoclass_content = "class"
 autodoc_default_options = {
-    'members': True,
-    'inherited-members': True,
-    'undoc-members': True,
-    'show-inheritance': True
+    "members": True,
+    "inherited-members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
 }
 autosummary_generate = True
 
 autodoc_type_aliases = {
-    'AwaitableOrValue': 'graphql.pyutils.AwaitableOrValue',
-    'FormattedSourceLocation': 'graphql.language.FormattedSourceLocation',
-    'Middleware': 'graphql.execution.Middleware',
-    'TypeMap': 'graphql.schema.TypeMap'
+    "AwaitableOrValue": "graphql.pyutils.AwaitableOrValue",
+    "FormattedSourceLocation": "graphql.language.FormattedSourceLocation",
+    "Middleware": "graphql.execution.Middleware",
+    "TypeMap": "graphql.schema.TypeMap",
 }
 
 # GraphQL-core top level modules with submodules that can be omitted.
 # Sometimes autodoc cannot find classes since it is looking for the
 # qualified form, but the documentation has the shorter form.
 # We need to give autodoc a little help in this cases.
 graphql_modules = {
-    'error': ['graphql_error'],
-    'execution': ['execute', 'middleware'],
-    'language': ['ast', 'directive_locations', 'location',
-                 'source', 'token_kind', 'visitor'],
-    'pyutils': ['simple_pub_sub', 'frozen_list', 'path'],
-    'type': ['definition', 'directives', 'schema'],
-    'utilities': ['find_breaking_changes', 'type_info'],
-    'validation': ['rules', 'validation_context']}
+    "error": ["graphql_error"],
+    "execution": ["execute", "middleware"],
+    "language": [
+        "ast",
+        "directive_locations",
+        "location",
+        "source",
+        "token_kind",
+        "visitor",
+    ],
+    "pyutils": ["simple_pub_sub", "frozen_list", "path"],
+    "type": ["definition", "directives", "schema"],
+    "utilities": ["find_breaking_changes", "type_info"],
+    "validation": ["rules", "validation_context"],
+}
 
 # GraphQL-core classes that autodoc sometimes cannot find
 # (e.g. where specified as string in type hints).
 # We need to give autodoc a little help in this cases, too:
 graphql_classes = {
-    'GraphQLAbstractType': 'type',
-    'GraphQLObjectType': 'type',
-    'GraphQLOutputType': 'type',
-    'GraphQLTypeResolver': 'type',
-    'Node': 'language',
-    'Source': 'language',
-    'SourceLocation': 'language'
+    "GraphQLAbstractType": "type",
+    "GraphQLObjectType": "type",
+    "GraphQLOutputType": "type",
+    "GraphQLTypeResolver": "type",
+    "Node": "language",
+    "Source": "language",
+    "SourceLocation": "language",
 }
 
 # ignore the following undocumented or internal references:
-ignore_references = set('''
+ignore_references = set(
+    """
 GNT GT KT T VT
 enum.Enum
 traceback
@@ -146,85 +154,87 @@
 graphql.validation.validation_context.VariableUsage
 graphql.validation.rules.known_argument_names.KnownArgumentNamesOnDirectivesRule
 graphql.validation.rules.provided_required_arguments.ProvidedRequiredArgumentsOnDirectivesRule
-'''.split())
+""".split()
+)
 
 ignore_references.update(__builtins__.keys())
 
 
 def on_missing_reference(app, env, node, contnode):
     """Fix or skip any missing references."""
-    if node.get('refdomain') != 'py':
+    if node.get("refdomain") != "py":
         return None
-    target = node.get('reftarget')
+    target = node.get("reftarget")
     if not target:
         return None
-    if target in ignore_references or target.endswith('Kwargs'):
+    if target in ignore_references or target.endswith("Kwargs"):
         return contnode
-    typ = node.get('reftype')
-    name = target.rsplit('.', 1)[-1]
-    if name in ('GT', 'GNT', 'KT', 'T', 'VT'):
+    typ = node.get("reftype")
+    name = target.rsplit(".", 1)[-1]
+    if name in ("GT", "GNT", "KT", "T", "VT"):
         return contnode
-    if typ == 'obj':
-        if target.startswith('typing.'):
-            if name in ('Any', 'Optional', 'Union'):
+    if typ == "obj":
+        if target.startswith("typing."):
+            if name in ("Any", "Optional", "Union"):
                 return contnode
-    if typ != 'class':
+    if typ != "class":
         return None
-    if '.' in target:  # maybe too specific
-        base_module, target = target.split('.', 1)
-        if base_module == 'graphql':
-            if '.' not in target:
+    if "." in target:  # maybe too specific
+        base_module, target = target.split(".", 1)
+        if base_module == "graphql":
+            if "." not in target:
                 return None
-            base_module, target = target.split('.', 1)
-        if '.' not in target:
+            base_module, target = target.split(".", 1)
+        if "." not in target:
             return None
         sub_modules = graphql_modules.get(base_module)
         if not sub_modules:
             return
-        sub_module = target.split('.', 1)[0]
+        sub_module = target.split(".", 1)[0]
         if sub_module not in sub_modules:
             return None
-        target = 'graphql.' + base_module + '.' + target.rsplit('.', 1)[-1]
+        target = "graphql." + base_module + "." + target.rsplit(".", 1)[-1]
     else:  # maybe not specific enough
         base_module = graphql_classes.get(target)
         if not base_module:
             return None
-        target = 'graphql.' + base_module + '.' + target
+        target = "graphql." + base_module + "." + target
     # replace target
-    if contnode.__class__.__name__ == 'Text':
+    if contnode.__class__.__name__ == "Text":
         contnode = contnode.__class__(target)
-    elif contnode.__class__.__name__ == 'literal':
+    elif contnode.__class__.__name__ == "literal":
         if len(contnode.children) != 1:
             return None
         textnode = contnode.children[0]
         contnode.children[0] = textnode.__class__(target)
     else:
         return None
-    node['reftarget'] = target
-    fromdoc = node.get('refdoc')
+    node["reftarget"] = target
+    fromdoc = node.get("refdoc")
     if not fromdoc:
-        doc_module = node.get('py:module')
+        doc_module = node.get("py:module")
         if doc_module:
-            if doc_module.startswith('graphql.'):
-                doc_module = doc_module.split('.', 1)[-1]
-            if doc_module not in graphql_modules and doc_module != 'graphql':
+            if doc_module.startswith("graphql."):
+                doc_module = doc_module.split(".", 1)[-1]
+            if doc_module not in graphql_modules and doc_module != "graphql":
                 doc_module = None
-        fromdoc = 'modules/' + (doc_module or base_module)
+        fromdoc = "modules/" + (doc_module or base_module)
     # try resolving again with replaced target
-    return env.domains['py'].resolve_xref(
-        env, fromdoc, app.builder, typ, target, node, contnode)
+    return env.domains["py"].resolve_xref(
+        env, fromdoc, app.builder, typ, target, node, contnode
+    )
 
 
 def on_skip_member(_app, what, name, _obj, skip, _options):
-    if what == 'class' and name == "__init__":
+    if what == "class" and name == "__init__":
         # we could set "special-members" to "__init__",
         # but this gives an error when documenting modules
         return False
     return skip
 
 
 def setup(app):
-    app.connect('missing-reference', on_missing_reference)
+    app.connect("missing-reference", on_missing_reference)
     app.connect("autodoc-skip-member", on_skip_member)
 
 
@@ -252,7 +262,7 @@ def setup(app):
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -268,15 +278,13 @@ def setup(app):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-html_theme_options = {
-    'navigation_depth': 5
-}
+html_theme_options = {"navigation_depth": 5}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -384,34 +392,36 @@ def setup(app):
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'GraphQL-core-3-doc'
+htmlhelp_basename = "GraphQL-core-3-doc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
-     #
-     # 'papersize': 'letterpaper',
-
-     # The font size ('10pt', '11pt' or '12pt').
-     #
-     # 'pointsize': '10pt',
-
-     # Additional stuff for the LaTeX preamble.
-     #
-     # 'preamble': '',
-
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'GraphQL-core-3.tex', 'GraphQL-core 3 Documentation',
-     'Christoph Zwerschke', 'manual'),
+    (
+        master_doc,
+        "GraphQL-core-3.tex",
+        "GraphQL-core 3 Documentation",
+        "Christoph Zwerschke",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -445,10 +455,7 @@ def setup(app):
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'graphql-core', 'GraphQL-core 3 Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "graphql-core", "GraphQL-core 3 Documentation", [author], 1)]
 
 # If true, show URL addresses after external links.
 #
@@ -461,9 +468,15 @@ def setup(app):
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'GraphQL-core', 'GraphQL-core 3 Documentation',
-     author, 'GraphQL-core 3', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "GraphQL-core",
+        "GraphQL-core 3 Documentation",
+        author,
+        "GraphQL-core 3",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.

tox.ini

@@ -63,4 +63,3 @@ commands =
     # to run the benchmarks: tox -e py311 -- -k benchmarks --benchmark-enable
     py37,py38,py39,py310,py311,pypy39,pypy310: pytest tests {posargs}
     py312: pytest tests {posargs: --cov-report=term-missing --cov=graphql --cov=tests --cov-fail-under=100}
-