IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Enable automatic formatting for `sphinx/domains/_*.py`

Browse Source
This commit is contained in:
Adam Turner 2024-10-05 03:34:02 +01:00
parent 77e2cbb2d3
commit 92aaf3db82
2 changed files with 37 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
.ruff.toml
View File

@ -448,7 +448,27 @@ exclude = [
"sphinx/application.py", "sphinx/application.py",
"sphinx/builders/latex/constants.py", "sphinx/builders/latex/constants.py",
"sphinx/config.py", "sphinx/config.py",
"sphinx/domains/*", "sphinx/domains/__init__.py",
"sphinx/domains/c/_parser.py",
"sphinx/domains/c/_ids.py",
"sphinx/domains/c/__init__.py",
"sphinx/domains/c/_symbol.py",
"sphinx/domains/c/_ast.py",
"sphinx/domains/changeset.py",
"sphinx/domains/citation.py",
"sphinx/domains/cpp/_parser.py",
"sphinx/domains/cpp/_ids.py",
"sphinx/domains/cpp/__init__.py",
"sphinx/domains/cpp/_symbol.py",
"sphinx/domains/cpp/_ast.py",
"sphinx/domains/index.py",
"sphinx/domains/javascript.py",
"sphinx/domains/math.py",
"sphinx/domains/python/_annotations.py",
"sphinx/domains/python/__init__.py",
"sphinx/domains/python/_object.py",
"sphinx/domains/rst.py",
"sphinx/domains/std/__init__.py",
"sphinx/ext/autodoc/__init__.py", "sphinx/ext/autodoc/__init__.py",
"sphinx/ext/autodoc/directive.py", "sphinx/ext/autodoc/directive.py",
"sphinx/ext/autodoc/importer.py", "sphinx/ext/autodoc/importer.py",

44
sphinx/domains/_domains_container.py
View File

@ -122,7 +122,6 @@ class _DomainsContainer:
math: MathDomain, math: MathDomain,
**domains: Domain, **domains: Domain,
) -> None: ) -> None:
# All domains, including core. # All domains, including core.
# Implemented as a dict for backwards compatibility. # Implemented as a dict for backwards compatibility.
self._domain_instances: Mapping[str, Domain] = { self._domain_instances: Mapping[str, Domain] = {
@ -171,7 +170,9 @@ class _DomainsContainer:
for domain in self._domain_instances.values(): for domain in self._domain_instances.values():
domain.clear_doc(docname) domain.clear_doc(docname)
def _merge_domain_data(self, docnames: Set[str], domain_data: dict[str, Any]) -> None: def _merge_domain_data(
self, docnames: Set[str], domain_data: dict[str, Any]
) -> None:
for domain_name, domain in self._domain_instances.items(): for domain_name, domain in self._domain_instances.items():
domain.merge_domaindata(docnames, domain_data[domain_name]) domain.merge_domaindata(docnames, domain_data[domain_name])
@ -202,60 +203,47 @@ class _DomainsContainer:
# Mapping interface: builtin domains # Mapping interface: builtin domains
@overload @overload
def __getitem__(self, key: Literal["c"]) -> CDomain: def __getitem__(self, key: Literal['c']) -> CDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["cpp"]) -> CPPDomain: def __getitem__(self, key: Literal['cpp']) -> CPPDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["changeset"]) -> ChangeSetDomain: def __getitem__(self, key: Literal['changeset']) -> ChangeSetDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["citation"]) -> CitationDomain: def __getitem__(self, key: Literal['citation']) -> CitationDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["index"]) -> IndexDomain: def __getitem__(self, key: Literal['index']) -> IndexDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["js"]) -> JavaScriptDomain: def __getitem__(self, key: Literal['js']) -> JavaScriptDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["math"]) -> MathDomain: def __getitem__(self, key: Literal['math']) -> MathDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["py"]) -> PythonDomain: def __getitem__(self, key: Literal['py']) -> PythonDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["rst"]) -> ReSTDomain: def __getitem__(self, key: Literal['rst']) -> ReSTDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["std"]) -> StandardDomain: def __getitem__(self, key: Literal['std']) -> StandardDomain: ... # NoQA: E704
...
# Mapping interface: first-party domains # Mapping interface: first-party domains
@overload @overload
def __getitem__(self, key: Literal["duration"]) -> DurationDomain: def __getitem__(self, key: Literal['duration']) -> DurationDomain: ... # NoQA: E704
...
@overload @overload
def __getitem__(self, key: Literal["todo"]) -> TodoDomain: def __getitem__(self, key: Literal['todo']) -> TodoDomain: ... # NoQA: E704
...
# Mapping interface: third-party domains # Mapping interface: third-party domains
@overload @overload
def __getitem__(self, key: str) -> Domain: def __getitem__(self, key: str) -> Domain: ... # NoQA: E704
...
def __getitem__(self, key: str) -> Domain: def __getitem__(self, key: str) -> Domain:
if domain := getattr(self, key, None): if domain := getattr(self, key, None):