From fb25d79be89598b4d99dd73a08eb5b19d33c63fb Mon Sep 17 00:00:00 2001
From: Laurent <lalmeras@gmail.com>
Date: Mon, 18 Jul 2022 18:53:22 +0200
Subject: [PATCH] Add source_provider setting for edit link

This patch allow to use `source_provider` to handle the case where `source_directory` is not a well-known url (https://gitlab.com, https://github.com, https://bitbucket.org).

This patch implies that project using spinx_basic_ng update their `theme.conf` file to add a `source_directory =` default setting (else this patch trigger errors at runtime).
---
 .../basic-ng/components/edit-this-page.html   | 41 ++++++++++++-------
 1 file changed, 26 insertions(+), 15 deletions(-)

diff --git a/src/sphinx_basic_ng/theme/basic-ng/components/edit-this-page.html b/src/sphinx_basic_ng/theme/basic-ng/components/edit-this-page.html
index be8d088..36fe625 100644
--- a/src/sphinx_basic_ng/theme/basic-ng/components/edit-this-page.html
+++ b/src/sphinx_basic_ng/theme/basic-ng/components/edit-this-page.html
@@ -5,6 +5,27 @@
   {%- set repo = sanitise_trailing_slash(theme_source_repository) -%}
   {%- set branch = theme_source_branch -%}
   {%- set subdirectory = sanitise_trailing_slash(theme_source_directory) -%}
+  {%- set provider = theme_source_provider -%}
+  
+  {%- if not provider -%}
+    {#- Don't allow http:// URLs -#}
+    {%- if repo.startswith(
+      (
+        "http://github.com/",
+        "http://gitlab.com/",
+        "http://bitbucket.org/",
+      )
+    ) -%}
+      {{ warning("Could not use `source_repository` provided. Please use https:// links in your `conf.py` file's `html_theme_options`.") }}
+    {#- Handle the relevant cases -#}
+    {%- elif repo.startswith("https://github.com/") -%}
+      {%- set provider = "github" -%}
+    {%- elif repo.startswith("https://gitlab.com/") -%}
+      {%- set provider = "gitlab" -%}
+    {%- elif repo.startswith("https://bitbucket.org/") -%}
+      {%- set provider = "bitbucket" -%}
+    {%- endif -%}
+  {%- endif -%}
 
   {#- Figure out the document's source file path. -#}
   {%- set relative_path = pagename + page_source_suffix -%}
@@ -13,26 +34,16 @@
   {%- else -%}
     {%- set document_path = subdirectory + "/" + relative_path -%}
   {%- endif -%}
-
-  {#- Don't allow http:// URLs -#}
-  {%- if repo.startswith(
-    (
-      "http://github.com/",
-      "http://gitlab.com/",
-      "http://bitbucket.org/",
-    )
-  ) -%}
-    {{ warning("Could not use `source_repository` provided. Please use https:// links in your `conf.py` file's `html_theme_options`.") }}
-  {#- Handle the relevant cases -#}
-  {%- elif repo.startswith("https://github.com/") -%}
+  
+  {%- if provider == "github" -%}
     {{ repo }}/edit/{{ branch }}/{{ document_path }}
-  {%- elif repo.startswith("https://gitlab.com/") -%}
+  {%- elif provider == "gitlab" -%}
     {{ repo }}/-/edit/{{ branch }}/{{ document_path }}
-  {%- elif repo.startswith("https://bitbucket.org/") -%}
+  {%- elif provider == "bitbucket" -%}
     {{ repo }}/src/{{ branch }}/{{ document_path }}?mode=edit&at={{ branch }}
   {#- Fail with a warning -#}
   {%- else -%}
-    {{ warning("Could not understand `source_repository` provided: " + repo) }}
+    {{ warning("`source_provider` <" + provider + "> not known and cannot be extracted from `source_repository` provided: " + repo) }}
   {%- endif -%}
 {%- endmacro -%}