Allow gitlab URL link shortening from non-gitlab/github.com domains

docs/user_guide/source-buttons.rst

@@ -4,6 +4,8 @@ Source Buttons
 
 Source buttons are links to the source of your page's content (either on your site, or on hosting sites like GitHub).
 
+.. _add-edit-button:
+
 Add an edit button
 ==================
 

docs/user_guide/theme-elements.md

@@ -212,7 +212,7 @@ All will end up as numbers in the rendered HTML, but in the source they look lik
 
 ## Link shortening for git repository services
 
-Many projects have links back to their issues / PRs hosted on platforms like **GitHub** or **GitLab**.
+Many projects have links back to their issues / PRs hosted on platforms like **GitHub**, **GitLab**, or **Bitbucket**.
 Instead of displaying these as raw links, this theme does some lightweight formatting for these platforms specifically.
 
 In **reStructuredText**, URLs are automatically converted to links, so this works automatically.
@@ -252,5 +252,25 @@ There are a variety of link targets supported, here's a table for reference:
 - `https://gitlab.com/gitlab-org`: https://gitlab.com/gitlab-org
 - `https://gitlab.com/gitlab-org/gitlab`: https://gitlab.com/gitlab-org/gitlab
 - `https://gitlab.com/gitlab-org/gitlab/-/issues/375583`: https://gitlab.com/gitlab-org/gitlab/-/issues/375583
+- `https://gitlab.com/gitlab-org/gitlab/-/merge_requests/174667`: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/174667
+
+**Bitbucket**
+
+- `https://bitbucket.org`: https://bitbucket.org
+- `https://bitbucket.org/atlassian/workspace/overview`: https://bitbucket.org/atlassian/workspace/overview
+- `https://bitbucket.org/atlassian/aui`: https://bitbucket.org/atlassian/aui
+- `https://bitbucket.org/atlassian/aui/pull-requests/4758`: https://bitbucket.org/atlassian/aui/pull-requests/4758
 
 Links provided with a text body won't be changed.
+
+If you have links to GitHub, GitLab, or Bitbucket repository URLs that are on non-standard domains
+(i.e., not on `github.com`, `gitlab.com`, or `bitbucket.org`, respectively), then these will be
+shortened if the base URL is given in the `html_context` section of your `conf.py` file (see
+{ref}`Add an edit button <add-edit-button>`), e.g.,
+
+```python
+html_context = {
+    "gitlab_url": "https://gitlab.mydomain.com",  # your self-hosted GitLab
+    ...
+}
+```

src/pydata_sphinx_theme/__init__.py

@@ -276,7 +276,27 @@ def setup(app: Sphinx) -> Dict[str, str]:
 
     app.add_html_theme("pydata_sphinx_theme", str(theme_path))
 
-    app.add_post_transform(short_link.ShortenLinkTransform)
+    if hasattr(app.config, "html_context"):
+        github_url = app.config.html_context.get("github_url", None)
+        gitlab_url = app.config.html_context.get("gitlab_url", None)
+        bitbucket_url = app.config.html_context.get("bitbucket_url", None)
+
+        url_update = {}
+        for url, platform in zip(
+            [github_url, gitlab_url, bitbucket_url], ["github", "gitlab", "bitbucket"]
+        ):
+            if url:
+                # remove "http[s]://" and leading/trailing "/"s
+                url = urlparse(url)._replace(scheme="").geturl().lstrip("/").rstrip("/")
+                url_update[url] = platform
+
+        class ShortenLinkTransformCustom(short_link.ShortenLinkTransform):
+            supported_platform = short_link.ShortenLinkTransform.supported_platform
+            supported_platform.update(url_update)
+
+        app.add_post_transform(ShortenLinkTransformCustom)
+    else:
+        app.add_post_transform(short_link.ShortenLinkTransform)
 
     app.connect("builder-inited", translator.setup_translators)
     app.connect("builder-inited", update_config)

src/pydata_sphinx_theme/assets/styles/base/_base.scss

@@ -48,7 +48,8 @@ a {
 
   // set up a icon next to the shorten links from github and gitlab
   &.github,
-  &.gitlab {
+  &.gitlab,
+  &.bitbucket {
     &::before {
       color: var(--pst-color-text-muted);
       font: var(--fa-font-brands);
@@ -63,6 +64,10 @@ a {
   &.gitlab::before {
     content: var(--pst-icon-gitlab);
   }
+
+  &.bitbucket::before {
+    content: var(--pst-icon-bitbucket);
+  }
 }
 
 %heading-style {

src/pydata_sphinx_theme/assets/styles/variables/_icons.scss

@@ -20,6 +20,7 @@ html {
   --pst-icon-search-minus: "\f010"; // fa-solid fa-magnifying-glass-minus
   --pst-icon-github: "\f09b"; // fa-brands fa-github
   --pst-icon-gitlab: "\f296"; // fa-brands fa-gitlab
+  --pst-icon-bitbucket: "\f171"; // fa-brands fa-bitbucket
   --pst-icon-share: "\f064"; // fa-solid fa-share
   --pst-icon-bell: "\f0f3"; // fa-solid fa-bell
   --pst-icon-pencil: "\f303"; // fa-solid fa-pencil

src/pydata_sphinx_theme/short_link.py

@@ -12,8 +12,8 @@
 
 class ShortenLinkTransform(SphinxPostTransform):
     """
-    Shorten link when they are coming from github or gitlab and add an extra class to
-    the tag for further styling.
+    Shorten link when they are coming from github, gitlab, or bitbucket and add
+    an extra class to the tag for further styling.
 
     Before:
         .. code-block:: html
@@ -37,6 +37,7 @@ class ShortenLinkTransform(SphinxPostTransform):
     supported_platform: ClassVar[dict[str, str]] = {
         "github.com": "github",
         "gitlab.com": "gitlab",
+        "bitbucket.org": "bitbucket",
     }
     platform = None
 
@@ -96,6 +97,22 @@ def parse_url(self, uri: ParseResult) -> str:
                     if parts[2] in ["issues", "pull", "discussions"]:
                         text += f"#{parts[-1]}"  # element number
 
+        elif self.platform == "bitbucket":
+            # split the url content
+            parts = path.split("/")
+
+            if len(parts) > 0:
+                text = parts[0]  # organisation
+            if len(parts) > 1 and not (
+                parts[-2] == "workspace" and parts[-1] == "overview"
+            ):
+                if len(parts) > 1:
+                    text += f"/{parts[1]}"  # repository
+                if len(parts) > 2:
+                    if parts[2] in ["issues", "pull-requests"]:
+                        itemnumber = parts[3]
+                        text += f"#{itemnumber}"  # element number
+
         elif self.platform == "gitlab":
             # cp. https://docs.gitlab.com/ee/user/markdown.html#gitlab-specific-references
             if "/-/" in path and any(