FEAT: link to source code on GitHub with linkcode (#242)

ComPWA · Dec 5, 2023 · 21a1daf · 21a1daf
1 parent d7c399b
commit 21a1daf
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -8,9 +8,11 @@
 
 from sphinx_api_relink.helpers import get_package_version
 
+ORGANIZATION = "ComPWA"
 REPO_NAME = "repo-maintenance"
 PACKAGE_NAME = "repoma"
 
+api_github_repo = f"{ORGANIZATION}/{REPO_NAME}"
 api_target_substitutions: dict[str, str | tuple[str, str]] = {
     "Array": "tomlkit.items.Array",
     "ConfigParser": "configparser.ConfigParser",
@@ -37,7 +39,6 @@
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
-    "sphinx.ext.viewcode",
     "sphinx_api_relink",
     "sphinx_copybutton",
     "sphinxarg.ext",
@@ -57,7 +58,7 @@
 html_theme = "sphinx_book_theme"
 html_theme_options = {
     "logo": {"text": REPO_NAME},
-    "repository_url": f"https://github.com/ComPWA/{REPO_NAME}",
+    "repository_url": f"https://github.com/{ORGANIZATION}/{REPO_NAME}",
     "repository_branch": "main",
     "path_to_docs": "docs",
     "use_repository_button": True,

diff --git a/pyproject.toml b/pyproject.toml
@@ -52,7 +52,7 @@ dev = [
 doc = [
     "Sphinx",
     "myst-parser",
-    "sphinx-api-relink >=0.0.3",
+    "sphinx-api-relink >=0.0.4",
     "sphinx-api-relink",
     "sphinx-argparse",
     "sphinx-book-theme",