Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Add shortcut for creating links to issues and PRs in the documentation (#685)

Benjamin Hacklf0055a1b2a52
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
index fc43fe5d7..36e101980 100644
--- a/docs/source/changelog.rst
+++ b/docs/source/changelog.rst
@@ -20,6 +20,11 @@ Configuration
Configuration tutorial for details.
+Documentation
+^^^^^^^^^^^^^
+
+#. Add ``:issue:`` and ``:pr:`` directives for simplifying linking to issues and
+ pull requests on GitHub (via :pr:`685`).
Mobjects, Scenes, and Animations
diff --git a/docs/source/conf.py b/docs/source/conf.py
index ae80574f7..dd222236d 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -56,6 +56,7 @@ extensions = [
"sphinx.ext.napoleon",
"sphinx.ext.autosummary",
"sphinx.ext.doctest",
+ "sphinx.ext.extlinks",
"sphinxext.opengraph",
"manim_directive",
]
@@ -103,6 +104,12 @@ html_static_path = ["_static"]
# This specifies any additional css files that will override the theme's
html_css_files = ["custom.css"]
+# external links
+extlinks = {
+ "issue": ("https://github.com/ManimCommunity/manim/issues/%s", "issue "),
+ "pr": ("https://github.com/ManimCommunity/manim/pull/%s", "pull request "),
+}
+
# opengraph settings
ogp_image = "https://www.manim.community/logo.png"
ogp_site_name = "Manim Community | Documentation"