adding an edit this page button to the TOC

docs/conf.py

@@ -65,6 +65,13 @@
     "twitter_url": "https://twitter.com/pandas_dev",
 }
 
+html_context = {
+    "github_user": "pandas-dev",
+    "github_repo": "pandas-sphinx-theme",
+    "github_version": "master",
+    "doc_path": "docs",
+}
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".

docs/user_guide/configuring.rst

@@ -48,3 +48,21 @@ at the bottom. You can hide these buttons with the following configuration:
    html_theme_options: {
      "show_prev_next": False
    }
+
+
+Add an Edit this Page button
+============================
+
+You can add a button to each page that will allow users to edit the page text
+directly and submit a pull request to update the documentation. To include this
+button in the right sidebar of each page, add the following configuration to
+your ``conf.py`` file:
+
+.. code:: python
+
+   html_context = {
+       "github_user": "<your-github-org>",
+       "github_repo": "<your-github-repo>",
+       "github_version": "<your-branch>",
+       "doc_path": "<path-from-root-to-your-docs>",
+   }

pandas_sphinx_theme/docs-toc.html

@@ -1,5 +1,6 @@
 {% set page_toc = get_page_toc_object() %}
 
+{% include "edit_this_page.html" %}
 {%- if page_toc.children | length > 1 %}
 <div class="tocsection onthispage"><i class="fas fa-list"></i> On this page</div>
 {% endif -%}

pandas_sphinx_theme/edit_this_page.html

@@ -0,0 +1,8 @@
+{% if sourcename is defined and github_user is defined %}
+{% set src = sourcename.split('.') %}
+<div class="tocsection editthispage">
+    <a href="https://github.com/{{ github_user }}/{{ github_repo }}/edit/{{ github_version }}/{{ doc_path }}/{{ pagename }}.{{ src[-2] }}">
+        <i class="fas fa-pencil-alt"></i> Edit this page
+    </a>
+</div>
+{% endif %}

pandas_sphinx_theme/static/css/custom.css

@@ -342,4 +342,8 @@ i.fa-twitter-square:before {
 
 div.tocsection i {
   padding-right: .5rem;
-}
+}
+
+div.editthispage {
+  padding-bottom: .6rem;
+}