From 56990ebb4a70a6dff94f23235d61a52d92afb989 Mon Sep 17 00:00:00 2001
From: Yuwen Hu <54161268+Oscilloscope98@users.noreply.github.com>
Date: Tue, 20 Sep 2022 16:26:27 +0800
Subject: [PATCH] [Document] Reword "Edit on Github" Button (#5802)

* Overide sphinx_rtd_theme style to remove 'Edit on Github' button

* Change 'Edit on Github' button to 'Edit this page' for every readthedocs pages

* Add lisence for adapting sphinx_rtd_theme/breadcrumbs.html
---
 .../source/_templates/breadcrumbs.html        | 60 +++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 docs/readthedocs/source/_templates/breadcrumbs.html

diff --git a/docs/readthedocs/source/_templates/breadcrumbs.html b/docs/readthedocs/source/_templates/breadcrumbs.html
new file mode 100644
index 00000000..599388dc
--- /dev/null
+++ b/docs/readthedocs/source/_templates/breadcrumbs.html
@@ -0,0 +1,60 @@
+<!--
+Copyright 2016 The BigDL Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+the following code is adapted from https://github.com/readthedocs/sphinx_rtd_theme/
+
+The MIT License (MIT)
+
+Copyright (c) 2013-2018 Dave Snider, Read the Docs, Inc. & contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+-->
+
+{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}
+
+<!--Change "Edit on Github" button on top-right corner to "Edit this page" in every page-->
+{%- block breadcrumbs_aside %}
+<li class="wy-breadcrumbs-aside">
+  {%- if hasdoc(pagename) and display_vcs_links %}
+    {%- if display_github %}
+      {%- if check_meta and 'github_url' in meta %}
+        <!-- User defined GitHub URL -->
+        <a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit this page') }}</a>
+      {%- else %}
+        <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" class="fa fa-github"> {{ _('Edit this page') }}</a>
+      {%- endif %}
+    {%- elif show_source and source_url_prefix %}
+      <a href="{{ source_url_prefix }}{{ pagename }}{{ page_source_suffix }}">{{ _('View page source') }}</a>
+    {%- elif show_source and has_source and sourcename %}
+      <a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
+    {%- endif %}
+  {%- endif %}
+</li>
+{%- endblock %}
\ No newline at end of file