diff options
author | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2023-02-17 22:11:14 +0000 |
---|---|---|
committer | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2023-02-18 01:58:05 +0000 |
commit | c8f4a03daceef4470ddbc34d5879ffd01588a116 (patch) | |
tree | b67cbca3c86b239e84e00b2ca5966e3c273ca18a /sphinx/domains/std.py | |
parent | 8de6638697b8c785f8022e1f526b549e74d033d1 (diff) | |
download | sphinx-git-c8f4a03daceef4470ddbc34d5879ffd01588a116.tar.gz |
Fix COM812
Diffstat (limited to 'sphinx/domains/std.py')
-rw-r--r-- | sphinx/domains/std.py | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index d93f84068..1e2870a8a 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -99,7 +99,7 @@ class EnvVarXRefRole(XRefRole): indexnode = addnodes.index() indexnode['entries'] = [ ('single', varname, tgtid, '', None), - ('single', _('environment variable; %s') % varname, tgtid, '', None) + ('single', _('environment variable; %s') % varname, tgtid, '', None), ] targetnode = nodes.target('', '', ids=[tgtid]) document.note_explicit_target(targetnode) @@ -292,7 +292,7 @@ def split_term_classifiers(line: str) -> list[str | None]: def make_glossary_term(env: BuildEnvironment, textnodes: Iterable[Node], index_key: str, - source: str, lineno: int, node_id: str | None, document: nodes.document + source: str, lineno: int, node_id: str | None, document: nodes.document, ) -> nodes.term: # get a text-only representation of the term and register it # as a cross-reference target @@ -553,7 +553,7 @@ class StandardDomain(Domain): searchprio=-1), 'envvar': ObjType(_('environment variable'), 'envvar'), 'cmdoption': ObjType(_('program option'), 'option'), - 'doc': ObjType(_('document'), 'doc', searchprio=-1) + 'doc': ObjType(_('document'), 'doc', searchprio=-1), } directives: dict[str, type[Directive]] = { @@ -656,7 +656,7 @@ class StandardDomain(Domain): def objects(self) -> dict[tuple[str, str], tuple[str, str]]: return self.data.setdefault('objects', {}) # (objtype, name) -> docname, labelid - def note_object(self, objtype: str, name: str, labelid: str, location: Any = None + def note_object(self, objtype: str, name: str, labelid: str, location: Any = None, ) -> None: """Note a generic object for cross reference. @@ -731,7 +731,7 @@ class StandardDomain(Domain): self.anonlabels[key] = data def process_doc( - self, env: BuildEnvironment, docname: str, document: nodes.document + self, env: BuildEnvironment, docname: str, document: nodes.document, ) -> None: for name, explicit in document.nametypes.items(): if not explicit: @@ -788,7 +788,7 @@ class StandardDomain(Domain): self.progoptions[program, name] = (docname, labelid) def build_reference_node(self, fromdocname: str, builder: Builder, docname: str, - labelid: str, sectname: str, rolename: str, **options: Any + labelid: str, sectname: str, rolename: str, **options: Any, ) -> Element: nodeclass = options.pop('nodeclass', nodes.reference) newnode = nodeclass('', '', internal=True, **options) @@ -813,7 +813,7 @@ class StandardDomain(Domain): return newnode def resolve_xref(self, env: BuildEnvironment, fromdocname: str, builder: Builder, - typ: str, target: str, node: pending_xref, contnode: Element + typ: str, target: str, node: pending_xref, contnode: Element, ) -> Element | None: if typ == 'ref': resolver = self._resolve_ref_xref @@ -1090,7 +1090,7 @@ class StandardDomain(Domain): builder: Builder, figtype: str, docname: str, - target_node: Element + target_node: Element, ) -> tuple[int, ...] | None: if figtype == 'section': if builder.name == 'latex': @@ -1128,7 +1128,7 @@ class StandardDomain(Domain): return None -def warn_missing_reference(app: Sphinx, domain: Domain, node: pending_xref +def warn_missing_reference(app: Sphinx, domain: Domain, node: pending_xref, ) -> bool | None: if (domain and domain.name != 'std') or node['reftype'] != 'ref': return None |