Document how to set custom GitHub url (#213) (#214)

pydata · Jun 25, 2020 · 3a538b1 · 3a538b1
1 parent 2bb0a9e
commit 3a538b1
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/user_guide/configuring.rst b/docs/user_guide/configuring.rst
@@ -87,6 +87,16 @@ You should also enable the edit option in your 'html_theme_options':
        "use_edit_page_button": True,
    }
 
+Optionally, if you have a self-hosted Github Enterprise instance, you can
+configure a custom url. This option defaults to 'https://github.com',
+and you do not need to specify it if you wish to use the default.
+
+.. code:: python
+
+   html_context = {
+       "github_url": "<your-github-url>",
+   }
+
 Configure the search bar position
 =================================