Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 25, 2020
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/user_guide/configuring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=================================

Expand Down