feat: added show_edit_this_page ext which decides to show the button or not based on the config

Author: Sivayogeith

doc/_templates/edit-this-page.html

@@ -1,5 +1,5 @@
 {# Displays a link to the edit interface of the page source in the specified Version Control System. #}
-{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix and pagename not in exclude_edit_page_button %}
+{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix and show_edit_this_page %}
   {% set src = sourcename.split('.') %}
   <div class="tocsection editthispage">
     <a href="{{ get_edit_provider_and_url()[1] }}">

doc/source/conf.py

@@ -69,6 +69,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.todo",
     "nbsphinx",
+    "show_edit_this_page",
 ]
 
 exclude_patterns = [
@@ -399,7 +400,12 @@
     "github_repo": "pandas",
     "github_version": "main",
     "doc_path": "doc/source",
-    "exclude_edit_page_button": ["index"],
+    "exclude_edit_this_page_pagename": [
+        "index"
+    ],  # specific pages, e.g., index, development/index
+    "exclude_edit_this_page_directory": [
+        "api"
+    ],  # all files in a directory, e.g., development, reference
 }
 
 # If false, no module index is generated.

doc/sphinxext/show_edit_this_page.py

@@ -0,0 +1,15 @@
+"""Sphinx extension for checking if Edit this Page button should show on this page."""
+
+def html_page_context(app, pagename, templatename, context, doctree):
+    if (
+        any(part in context['exclude_edit_this_page_directory'] for part in pagename.split("/")) or
+        pagename in context['exclude_edit_this_page_pagename']
+    ):
+        context['show_edit_this_page'] = False
+    else:
+        context['show_edit_this_page'] = True
+            
+    
+def setup(app):
+    app.connect('html-page-context', html_page_context)
+    return {"parallel_read_safe": True}