sphinxcontrib.external-links 0.1.0__tar.gz

sphinxcontrib_external_links-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Kyle Finley
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sphinxcontrib_external_links-0.1.0/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.1
+Name: sphinxcontrib.external-links
+Version: 0.1.0
+Summary: Sphinx extension for easily adding reusable external links.
+Home-page: https://github.com/ITProKyle/sphinxcontrib.external-links
+License: Apache-2.0
+Keywords: documentation,extension,sphinx
+Author: Kyle Finley
+Author-email: kyle@finley.sh
+Requires-Python: >=3.9,<4.0
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Software Development :: Documentation
+Requires-Dist: sphinx (>=7.2.6,<8.0.0)
+Project-URL: Documentation, https://sphinxcontribexternal-links.readthedocs.io/
+Project-URL: Repository, https://github.com/ITProKyle/sphinxcontrib.external-links
+Project-URL: bugs, https://github.com/ITProKyle/sphinxcontrib.external-links/issues
+Project-URL: changelog, https://github.com/ITProKyle/sphinxcontrib.external-links/releases
+Project-URL: issues, https://github.com/ITProKyle/sphinxcontrib.external-links/issues
+Description-Content-Type: text/markdown
+
+# sphinxcontrib.external-links
+
+Sphinx extension for easily adding reusable external links.
+
+## Features
+
+- default list of commonly used external links
+- user configurable links
+- check documentation for hardcoded links that can be replaced
+- compatible with the Sphinx's `linkcheck` builder to check link integrity
+- - global [substitutions](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions)
+
+## Usage
+
+```python
+external_links = {
+    "Google": "https://google.com",  # matches ":link:`google`", ":link:`Google`", etc
+}
+external_links_substitutions = {
+    "dict": ":class:`dict`",
+}
+```
+
+```rst
+Provide a link to :link:`Google` to :link:`google.com <google>`.
+This thing is a |dict|.
+```
+

sphinxcontrib_external_links-0.1.0/README.md

@@ -0,0 +1,27 @@
+# sphinxcontrib.external-links
+
+Sphinx extension for easily adding reusable external links.
+
+## Features
+
+- default list of commonly used external links
+- user configurable links
+- check documentation for hardcoded links that can be replaced
+- compatible with the Sphinx's `linkcheck` builder to check link integrity
+- - global [substitutions](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions)
+
+## Usage
+
+```python
+external_links = {
+    "Google": "https://google.com",  # matches ":link:`google`", ":link:`Google`", etc
+}
+external_links_substitutions = {
+    "dict": ":class:`dict`",
+}
+```
+
+```rst
+Provide a link to :link:`Google` to :link:`google.com <google>`.
+This thing is a |dict|.
+```

sphinxcontrib_external_links-0.1.0/pyproject.toml

@@ -0,0 +1,217 @@
+[tool.poetry]
+name = "sphinxcontrib.external-links"
+version = "0.1.0"
+authors = ["Kyle Finley <kyle@finley.sh>"]
+classifiers = [
+  "Framework :: Sphinx :: Extension",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.9",
+  "Topic :: Documentation :: Sphinx",
+  "Topic :: Software Development :: Documentation",
+]
+description = "Sphinx extension for easily adding reusable external links."
+documentation = "https://sphinxcontribexternal-links.readthedocs.io/"
+homepage = "https://github.com/ITProKyle/sphinxcontrib.external-links"
+keywords = [
+  "documentation",
+  "extension",
+  "sphinx",
+]
+license = "Apache-2.0"
+packages = [{include = "sphinxcontrib"}]
+readme = "README.md"
+repository = "https://github.com/ITProKyle/sphinxcontrib.external-links"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+sphinx = "^7.2.6"
+
+[tool.poetry.group.dev.dependencies]
+pre-commit = "^3.7.0"
+
+[tool.poetry.group.docs.dependencies]
+doc8 = "^1.1.1"
+furo = "^2024.1.29"
+sphinx-autobuild = "^2024.2.4"
+sphinx-copybutton = "^0.5.2"
+sphinx-design = "^0.5.0"
+sphinxcontrib-jquery = "^4.1"
+sphinxcontrib-trio = "^1.1.2"
+
+[tool.poetry.group.lint.dependencies]
+black = "^24.3.0"
+ruff = "^0.3.4"
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.1.1"
+pytest-cov = "^5.0.0"
+pytest-mock = "^3.14.0"
+pytest-sugar = ">=1.0.0"
+pytest-xdist = {extras = ["psutil"], version = "^3.5.0"}
+
+[tool.poetry.urls]
+bugs = "https://github.com/ITProKyle/sphinxcontrib.external-links/issues"
+changelog = "https://github.com/ITProKyle/sphinxcontrib.external-links/releases"
+issues = "https://github.com/ITProKyle/sphinxcontrib.external-links/issues"
+
+[tool.black]
+force-exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.venv
+  | _build
+  | build
+  | dist
+  | node_modules
+)/
+'''
+include = '\.pyi?$'
+line-length = 100
+target-version = ["py310", "py311", "py312", "py39"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "@overload",
+  "cov: ignore",  # standard exclude comment
+  "if TYPE_CHECKING:",  # excluded blocks
+  "if __name__ == .__main__.:",
+  "raise AssertionError",  # defensive exceptions
+  "raise NotImplementedError",
+]
+fail_under = 100
+precision = 2
+show_missing = true
+
+[tool.coverage.run]
+branch = false  # not correctly reported - https://github.com/nedbat/coveragepy/issues/605
+omit = [
+  "*/type_defs.py",
+]
+
+[tool.doc8]
+ignore = [
+  "D001",  # Line too long
+]
+
+[tool.poetry-dynamic-versioning]  # poetry self add "poetry-dynamic-versioning[plugin]"
+bump = true
+enable = false
+fix-shallow-repository = true
+metadata = false
+strict = true
+style = "pep440"
+
+[tool.pyright]
+exclude = [
+  "**/.eggs",
+  "**/.git",
+  "**/.venv",
+  "**/__pycache__",
+  "**/docs",
+  "**/node_modules",
+  "**/typings",
+]
+pythonPlatform = "All"
+pythonVersion = "3.9"
+reportDuplicateImport = "none"
+reportImportCycles = "none"
+reportIncompatibleMethodOverride = "warning"
+reportMissingTypeStubs = "none"
+reportPrivateUsage = "none"
+reportUnknownMemberType = "none"
+reportUnnecessaryIsInstance = "warning"
+reportUnusedImport = "none"
+reportUnusedVariable = "none"
+strictParameterNoneValue = false
+typeCheckingMode = "strict"
+useLibraryCodeForTypes = true
+venv = ".venv"
+
+[tool.pytest.ini_options]
+addopts = [
+  "--cov-config=pyproject.toml",
+]
+filterwarnings = [
+  "ignore::pytest_mock.PytestMockWarning",
+]
+markers = [
+  "wip: isolate tests currently being worked on.",
+]
+python_classes = ["Test*"]
+python_files = ["test_*.py"]
+python_functions = ["test_*"]
+testpaths = ["tests"]
+
+[tool.ruff]  # https://docs.astral.sh/ruff/settings/#top-level
+force-exclude = true
+line-length = 120
+show-fixes = true
+target-version = "py39"
+
+[tool.ruff.lint]  # https://docs.astral.sh/ruff/settings/#lint
+ignore = [
+  "ANN101",  # Missing type annotation for `self` in method
+  "ANN102",  # Missing type annotation for `cls` in classmethod
+  "COM812",  # Trailing comma missing
+  "D203",  # 1 blank line required before class docstring
+  "D213",  # Multi-line docstring summary should start at the second line
+  "D215",  # Section underline is over-indented
+  "D403",  # First word of the first line should be capitalized
+  "D406",  # Section name should end with a newline
+  "D407",  # Missing dashed underline after section
+  "D408",  # Section underline should be in the line following the section's name
+  "D409",  # Section underline should match the length of its name
+  "ERA001",  # Found commented-out code  # NOTE (kyle): incorrectly detects cspell
+  "FIX002",  # Line contains TODO
+  "TD003",  # Missing issue link on the line following this TODO
+  "TID252",  # Relative imports from parent modules are banned
+]
+ignore-init-module-imports = true
+select = ["ALL"]
+
+[tool.ruff.lint.extend-per-file-ignores]  # https://docs.astral.sh/ruff/settings/#lintextend-per-file-ignores
+"*.py" = [
+  "PYI024",  # Use `typing.NamedTuple` instead of `collections.namedtuple` - should only apply to pyi
+]
+"tests/*" = [
+  "FBT001",  # Boolean positional arg in function definition - this is fine here
+  "FBT003",  # Boolean positional value in function call - this is fine here
+  "PT004",  # Fixture does not return anything, add leading underscore
+  "S101",  # Use of `assert` detected - this is fine here
+  "S108",  # Probable insecure usage of temporary file or directory
+  "S604",  # Function call with `shell=True` parameter identified - this is fine here
+  "SLF001",  # Private member accessed - fine in tests
+]
+
+[tool.ruff.lint.flake8-type-checking]  # https://docs.astral.sh/ruff/settings/#lint_flake8-type-checking_runtime-evaluated-base-classes
+runtime-evaluated-base-classes = [
+  "pydantic.BaseModel",
+  "pydantic.BeforeValidator",
+]
+
+[tool.ruff.lint.pydocstyle]  # https://docs.astral.sh/ruff/settings/#lintpydocstyle
+convention = "google"
+
+[tool.ruff.lint.pylint]  # https://docs.astral.sh/ruff/settings/#lintpylint
+allow-magic-value-types = ["bytes", "int", "str"]
+max-args = 15
+max-returns = 10
+
+[tool.tomlsort]
+all = true
+in_place = true
+sort_first = ["tool", "tool.poetry"]
+spaces_before_inline_comment = 2
+trailing_comma_inline_array = true
+overrides."tool.poetry".first = ["name", "version"]
+overrides."tool.poetry.dependencies".first = ["python"]
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core"]

sphinxcontrib_external_links-0.1.0/sphinxcontrib/external_links/__init__.py

@@ -0,0 +1,38 @@
+"""Sphinx extension sphinxcontrib.external-links."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+from typing import TYPE_CHECKING
+
+from . import constants, type_defs
+from ._roles import links_role
+from ._transforms import ExternalLinkChecker, GlobalSubstitutions
+
+if TYPE_CHECKING:
+    from sphinx.application import Sphinx
+
+try:
+    __version__ = version(__name__)
+except PackageNotFoundError:  # cov: ignore
+    # package is not installed
+    __version__ = "0.0.0"
+
+
+def setup_roles(app: Sphinx) -> None:
+    """Setup roles."""
+    app.add_role("link", links_role(app.config.external_links))
+
+
+def setup(app: Sphinx) -> type_defs.ExtensionMetadata:
+    """Setup extension."""
+    app.add_config_value("external_links", default={}, rebuild="env")
+    app.add_config_value("external_links_detect_hardcoded_links", default=True, rebuild="env")
+    app.add_config_value("external_links_substitutions", default={}, rebuild="env")
+    app.add_transform(GlobalSubstitutions)
+    app.connect("builder-inited", setup_roles)
+    app.add_post_transform(ExternalLinkChecker)
+    return {"version": __version__, "parallel_read_safe": True}
+
+
+__all__ = ["constants", "type_defs"]

sphinxcontrib_external_links-0.1.0/sphinxcontrib/external_links/_case_insensitive_mapping.py

@@ -0,0 +1,46 @@
+"""case-insensitive :class:`collections.abc.Mapping`."""
+
+from __future__ import annotations
+
+import re
+from collections import OrderedDict
+from collections.abc import Mapping
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+
+class CaseInsensitiveMapping(Mapping[str, str]):
+    """A case-insensitive :class:`collections.abc.Mapping` object."""
+
+    def __init__(self, data: Mapping[str, str] | None = None, **kwargs: str) -> None:
+        """Instantiate class."""
+        data = {} if data is None else {k.lower(): v for k, v in data.items()}
+        self._store = OrderedDict(data)
+        self._store.update(**{k.lower(): v for k, v in kwargs.items()})
+
+    def __getitem__(self, key: str) -> str:
+        """Get value from object, ignoring case."""
+        return self._store[key.lower()]
+
+    def __hash__(self) -> int:
+        """Make the object hashable."""
+        return hash(frozenset(self.items()))
+
+    def __iter__(self) -> Generator[str, str, None]:
+        """Iterate over object."""
+        yield from iter(self._store)
+
+    def __len__(self) -> int:
+        """Length of object."""
+        return len(self._store)
+
+    def find_value(self, value: re.Pattern[str] | str) -> CaseInsensitiveMapping:
+        """Find value."""
+        value_pattern = re.compile(re.escape(value)) if isinstance(value, str) else value
+        rv: OrderedDict[str, str] = OrderedDict()
+        for k, v in self.items():
+            if value_pattern.match(v):
+                rv[k] = v
+        return CaseInsensitiveMapping(rv)

sphinxcontrib_external_links-0.1.0/sphinxcontrib/external_links/_roles.py

@@ -0,0 +1,49 @@
+"""Roles."""
+
+from __future__ import annotations
+
+import functools
+from typing import TYPE_CHECKING, Any
+
+from docutils.nodes import reference
+from docutils.utils import unescape
+from sphinx.util.nodes import split_explicit_title
+
+from ._case_insensitive_mapping import CaseInsensitiveMapping
+from .constants import COMMON_LINKS
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+    from docutils.nodes import Node, system_message
+    from docutils.parsers.rst.states import Inliner
+    from sphinx.util.typing import RoleFunction
+
+
+@functools.cache
+def _find_uri(links: CaseInsensitiveMapping, target: str) -> str:
+    """Find URI with caching."""
+    return links[target]
+
+
+def links_role(user_links: dict[str, str] | None = None) -> RoleFunction:
+    """Generate link role function, injecting user provided collection of links."""
+    links = CaseInsensitiveMapping(COMMON_LINKS, **user_links if user_links else {})
+
+    def role_func(
+        role: str,  # noqa: ARG001
+        rawtext: str,  # noqa: ARG001
+        text: str,
+        lineno: int,  # noqa: ARG001
+        inliner: Inliner,  # noqa: ARG001
+        options: dict[str, Any] | None = None,  # noqa: ARG001
+        content: Sequence[str] = (),  # noqa: ARG001
+    ) -> tuple[list[Node], list[system_message]]:
+        """Implement role."""
+        _has_explicit_title, title, target = split_explicit_title(unescape(text))
+        node: Node = reference(
+            title, title, internal=False, refuri=_find_uri(links, target.lower())
+        )
+        return [node], []
+
+    return role_func

sphinxcontrib_external_links-0.1.0/sphinxcontrib/external_links/_transforms.py

@@ -0,0 +1,106 @@
+"""External link checker."""
+
+from __future__ import annotations
+
+import re
+from typing import TYPE_CHECKING
+
+from docutils.nodes import paragraph, reference, substitution_reference
+from docutils.utils import new_document
+from sphinx.transforms import SphinxTransform
+from sphinx.transforms.post_transforms import SphinxPostTransform
+from sphinx.util import logging
+from sphinx.util.docutils import LoggingReporter
+
+from ._case_insensitive_mapping import CaseInsensitiveMapping
+from .constants import COMMON_LINKS
+
+if TYPE_CHECKING:
+    from docutils.nodes import Node, document
+
+LOGGER = logging.getLogger(__name__)
+
+
+class ExternalLinkChecker(SphinxPostTransform):
+    """Check each external link to see if it can be replaced with a reference."""
+
+    _external_links: CaseInsensitiveMapping
+    default_priority = 501
+
+    def run(self, **_kwargs: object) -> None:
+        """Main method of post transforms."""
+        if not self.config.external_links_detect_hardcoded_links:
+            return
+
+        self._external_links = CaseInsensitiveMapping(
+            COMMON_LINKS, **self.app.config.external_links
+        )
+        for refnode in self.document.findall(reference):
+            self.check_reference(refnode)
+
+    def check_reference(self, ref_node: reference) -> None:
+        """Check if the reference can be replaced.
+
+        Args:
+            links: Mapping of referencable links.
+            ref_node: The reference node to check.
+
+        """
+        if "internal" in ref_node or "refuri" not in ref_node:
+            return
+
+        matches = self._external_links.find_value(
+            re.compile(re.escape(ref_node["refuri"]) + r"?(/)$")
+        )
+        if not matches:
+            return
+
+        LOGGER.warning(
+            'hardcoded link "%s" to %s could be replaced by a reference (%s)',
+            ref_node.astext(),
+            ref_node["refuri"],
+            ", ".join(self.make_suggestions(matches, ref_node)),
+            location=ref_node,
+        )
+
+    def make_suggestions(self, matches: CaseInsensitiveMapping, ref_node: reference) -> list[str]:
+        """Make suggestions based on matches."""
+        title = ref_node.astext()
+        rv: list[str] = []
+        for k in matches:
+            if not ref_node["refuri"].startswith(title) and title == k:
+                rv.append(f":link:`{k}`")
+            else:
+                rv.append(f":link:`{title} <{k}>`")
+        return rv
+
+
+class GlobalSubstitutions(SphinxTransform):
+    """Transform for global substitutions."""
+
+    default_priority = 211
+
+    def __init__(self, document: document, startnode: Node | None = None) -> None:
+        super().__init__(document, startnode)
+        self.parser = self.app.registry.create_source_parser(self.app, "rst")
+
+    def apply(self) -> None:
+        """Apply substitutions."""
+        settings, source = self.document.settings, self.document["source"]
+        subs = self.document.settings.env.config.external_links_substitutions
+        to_handle = set(subs.keys()) - set(self.document.substitution_defs)
+
+        for ref in self.document.findall(substitution_reference):
+            refname = ref["refname"]
+            if refname in to_handle:
+                text = subs[refname]
+
+                doc = new_document(source, settings)
+                doc.reporter = LoggingReporter.from_reporter(doc.reporter)
+                self.parser.parse(text, doc)
+
+                substitution = doc.next_node()
+                # Remove encapsulating paragraph
+                if isinstance(substitution, paragraph):
+                    substitution = substitution.next_node()
+                ref.replace_self(substitution)

sphinxcontrib_external_links-0.1.0/sphinxcontrib/external_links/constants.py

@@ -0,0 +1,56 @@
+"""Constants."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+
+COMMON_LINKS: Mapping[str, str] = {
+    "apache": "http://www.apache.org",
+    "apple": "http://www.apple.com/",
+    "black": "https://github.com/psf/black",
+    "couchdb": "http://couchdb.apache.org/",
+    "css": "http://www.w3.org/Style/CSS/",
+    "debian": "https://www.debian.org/",
+    "docker hub": "https://hub.docker.com/",
+    "docker": "http://docker.io/",
+    "gist": "https://gist.github.com/",
+    "gitlab": "https://gitlab.com/",
+    "google": "https://google.com/",
+    "jinja": "http://jinja.pocoo.org/",
+    "jinja2": "http://jinja.pocoo.org/",
+    "linux": "https://www.kernel.org/",
+    "macos": "http://www.apple.com/osx/",
+    "microsoft": "http://microsoft.com/",
+    "nginx": "http://nginx.org",
+    "nix": "http://nixos.org/nix/",
+    "npm": "https://www.npmjs.com/",
+    "poetry": "https://github.com/python-poetry/poetry",
+    "postgres": "http://www.postgresql.org/",
+    "postgresql": "http://www.postgresql.org/",
+    "pre-commit": "https://github.com/pre-commit/pre-commit",
+    "pydantic": "https://github.com/pydantic/pydantic",
+    "pypi": "https://pypi.org/",
+    "pyright": "https://github.com/microsoft/pyright",
+    "pytest": "https://github.com/pytest-dev/pytest/",
+    "python": "https://www.python.org/",
+    "rdt": "https://readthedocs.com/",
+    "readthedocs": "https://readthedocs.com/",
+    "restructuredtext": "https://docutils.sourceforge.io/rst.html",
+    "rich": "https://github.com/Textualize/rich",
+    "rst": "https://docutils.sourceforge.io/rst.html",
+    "ruff": "https://github.com/astral-sh/ruff",
+    "sphinx": "https://github.com/sphinx-doc/sphinx",
+    "sqlite": "http://www.sqlite.org/",
+    "test pypi": "https://test.pypi.org/",
+    "typeshed": "https://github.com/python/typeshed",
+    "ubuntu": "http://www.ubuntu.com/",
+    "visual studio code": "https://code.visualstudio.com/",
+    "vscode": "https://code.visualstudio.com/",
+    "w3c": "http://www.w3.org/",
+    "windows": "http://windows.microsoft.com/",
+}
+"""Mapping of common links."""

sphinxcontrib_external_links-0.1.0/sphinxcontrib/external_links/type_defs.py

@@ -0,0 +1,31 @@
+"""Type definitions."""
+
+from __future__ import annotations
+
+from typing import TypedDict
+
+
+class ExtensionMetadata(TypedDict, total=False):
+    """The metadata returned by an extension's ``setup()`` function.
+
+    Copy/paste for early use as it's staged for release in sphinx >7.2.6.
+
+    """
+
+    version: str
+    """The extension version (default: ``'unknown version'``)."""
+
+    env_version: int
+    """An integer that identifies the version of env data added by the extension."""
+
+    parallel_read_safe: bool
+    """Indicate whether parallel reading of source files is supported
+    by the extension.
+
+    """
+
+    parallel_write_safe: bool
+    """Indicate whether parallel writing of output files is supported
+    by the extension (default: ``True``).
+
+    """