diff options
| author | Wolfgang Müller | 2024-07-22 14:30:05 +0200 |
|---|---|---|
| committer | Wolfgang Müller | 2024-07-22 14:32:53 +0200 |
| commit | 31b1e182b3146ce16e3bd374bde63e0708b74490 (patch) | |
| tree | bffaadf005a8e3cce24c6cdeb028ad35c002a9e0 | |
| parent | 4e6425585be1e9f2e2b9bc6dc5a5d3ba0f611d27 (diff) | |
| download | hircine-31b1e182b3146ce16e3bd374bde63e0708b74490.tar.gz | |
docs: Use sphinx_issues to link to commits
| -rw-r--r-- | docs/changelog.rst | 3 | ||||
| -rw-r--r-- | docs/conf.py | 5 | ||||
| -rw-r--r-- | poetry.lock | 20 | ||||
| -rw-r--r-- | pyproject.toml | 1 |
4 files changed, 26 insertions, 3 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst index 0426a5d..eec62d7 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,8 +5,7 @@ Changelog ----- - Use ``float`` instead of ``int`` in the GraphQL schema for the Archive size. - See `ddeeb37 - <https://git.oriole.systems/hircine/commit/?id=ddeeb372250409da1f31a0522fb715e552c1f450>`_. + See :commit:`ddeeb372250409da1f31a0522fb715e552c1f450`. 0.1.0 "Satanic Satyr" --------------------- diff --git a/docs/conf.py b/docs/conf.py index 53eac6b..a3d9bdc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,6 +11,7 @@ copyright = "2022-2024, Wolfgang Müller" extensions = [ "sphinx.ext.autodoc", "sphinx.ext.intersphinx", + "sphinx_issues", ] templates_path = ["_templates"] exclude_patterns = [] @@ -29,3 +30,7 @@ intersphinx_mapping = { "python": ("https://docs.python.org/3", None), "packaging": ("https://packaging.python.org/en/latest", None), } + +issues_default_group_project = "/hircine" +issues_commit_uri = "https://git.oriole.systems/{project}/commit/?id={commit}" +issues_commit_prefix = "" diff --git a/poetry.lock b/poetry.lock index e97ad56..90c45d9 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1152,6 +1152,24 @@ sphinx = ">=4.0" docs = ["furo", "ipython", "myst-parser", "sphinx-copybutton", "sphinx-inline-tabs"] [[package]] +name = "sphinx-issues" +version = "4.1.0" +description = "A Sphinx extension for linking to your project's issue tracker" +optional = false +python-versions = ">=3.8" +files = [ + {file = "sphinx_issues-4.1.0-py3-none-any.whl", hash = "sha256:d779dddff441175c9fddb7a4018eca38f9f6cdb1e0a2fe31d93b4f89587c7ba1"}, + {file = "sphinx_issues-4.1.0.tar.gz", hash = "sha256:a67f7ef31d164b420b2f21b6c9b020baeb4a014afd4045f5be314c984e8ee520"}, +] + +[package.dependencies] +sphinx = "*" + +[package.extras] +dev = ["pre-commit (>=3.6,<4.0)", "sphinx-issues[tests]", "tox"] +tests = ["pytest"] + +[[package]] name = "sphinxcontrib-applehelp" version = "1.0.8" description = "sphinxcontrib-applehelp is a Sphinx extension which outputs Apple help books" @@ -1664,4 +1682,4 @@ files = [ [metadata] lock-version = "2.0" python-versions = "^3.12" -content-hash = "ada046d4e6524de7e9fe83ca4eed53f5ca05c0e75058030a58cb300602828b4c" +content-hash = "26f12bd44b97acb3b207b6a8471b37222e857ec471db861a322eea35cb085e4f" diff --git a/pyproject.toml b/pyproject.toml index 1197221..7dfc6eb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -35,6 +35,7 @@ types-pillow = "^10.1.0.2" pytest-cov = "^5.0.0" sphinx = "^7.2.6" furo = "^2024.1.29" +sphinx-issues = "^4.1.0" [build-system] requires = ["poetry-core"] |