From 789c5a0e736c56f2709a11205852aa454b5e72ab Mon Sep 17 00:00:00 2001
From: Eric Holscher <eric@ericholscher.com>
Date: Fri, 3 Jun 2016 16:09:49 -0700
Subject: [PATCH] Allow users to override "Edit" links to GH/BB.

This allows you to set a :github_url: or :bitbucket_url:
in your file metadata and have it override the Edit URL.
---
 sphinx_rtd_theme/breadcrumbs.html | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/sphinx_rtd_theme/breadcrumbs.html b/sphinx_rtd_theme/breadcrumbs.html
index 7c2ce5c8..2266d403 100644
--- a/sphinx_rtd_theme/breadcrumbs.html
+++ b/sphinx_rtd_theme/breadcrumbs.html
@@ -6,6 +6,14 @@
 {% set suffix = source_suffix %}
 {% endif %}
 
+{% if meta is defined and 'github_url' in meta %}
+{% set display_github = True %}
+{% endif %}
+
+{% if meta is defined and 'bitbucket_url' in meta %}
+{% set display_bitbucket = True %}
+{% endif %}
+
 <div role="navigation" aria-label="breadcrumbs navigation">
   <ul class="wy-breadcrumbs">
     <li><a href="{{ pathto(master_doc) }}">Docs</a> &raquo;</li>
@@ -15,10 +23,20 @@
     <li>{{ title }}</li>
     <li class="wy-breadcrumbs-aside">
       {% if pagename != "search" %}
-        {% if display_github %}
-          <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> Edit on GitHub</a>
+          {% if display_github %}
+          {% if meta is defined and 'github_url' in meta %}
+            <!-- User defined GitHub URL -->
+            <a href="{{ meta['github_url'] }}" class="fa fa-github"> Edit on GitHub</a>
+          {% else %}
+            <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> Edit on GitHub</a>
+          {% endif %}
         {% elif display_bitbucket %}
-          <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-bitbucket"> Edit on Bitbucket</a>
+          {% if meta is defined and 'github_url' in meta %}
+            <!-- User defined Bitbucket URL -->
+            <a href="{{ meta['bitbucket_url'] }}" class="fa fa-github"> Edit on Bitbucket</a>
+          {% else %}
+            <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-bitbucket"> Edit on Bitbucket</a>
+          {% endif %}
         {% elif show_source and source_url_prefix %}
           <a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">View page source</a>
         {% elif show_source and has_source and sourcename %}