DOC: automatically link API in reST syntax

ComPWA · Oct 6, 2023 · e458423 · e458423
1 parent 5c37e9d
commit e458423
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -75,6 +75,7 @@ def get_version(package_name: str) -> str:
 copybutton_prompt_is_regexp = True
 copybutton_prompt_text = r">>> |\.\.\. "  # doctest
 copyright = "2023, Common Partial Wave Analysis"  # noqa: A001
+default_role = "py:obj"
 extensions = [
     "myst_parser",
     "sphinx.ext.autodoc",
@@ -122,6 +123,7 @@ def get_version(package_name: str) -> str:
     (r"py:.*", r"ruamel\.yaml\..*"),
 ]
 nitpicky = True
+primary_domain = "py"
 project = REPO_NAME
 release = get_version(REPO_NAME)
 version = get_version(REPO_NAME)
diff --git a/src/repoma/utilities/project_info.py b/src/repoma/utilities/project_info.py
@@ -90,7 +90,7 @@ def _extract_python_versions(classifiers: List[str]) -> Optional[List[str]]:
 
 
 def get_pypi_name(pyproject: Optional[TOMLDocument] = None) -> str:
-    """Extract package name for PyPI from `setup.cfg`.
+    """Extract package name for PyPI from :file:`setup.cfg`.
 
     >>> get_pypi_name()
     'repo-maintenance'