Source Buttons#

Source buttons are links to the source of your page’s content (either on your site, or on hosting sites like GitHub).

Add an edit 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 add an edit button, use the following configuration:

html_theme_options = {
    "use_edit_page_button": True
}

By default, an edit buttion is added at the top of a page. You can also place the edit button at the bottom of a page using the following configuration:

html_theme_options = {
    "article_bottom_right": "edit-this-page.html"
}

View Source link#

By default, this theme adds a button link to view the source of a page at the bottom of the page. To disable it, use the following configuration:

html_show_sourcelink = False

You can also place the source link button at the top of a page using the following configuration:

html_theme_options = {
    "article_top_right": "sourcelink.html"
}

Last updated on Jan 16, 2024.

Changing sidenav elements

Search button