Removing “Edit on …” Buttons from Documentation¶
When building your documentation, Read the Docs automatically adds buttons at the top of your documentation and in the versions menu that point readers to your repository to make changes. For instance, if your repository is on GitHub, a button that says “Edit on GitHub” is added in the top-right corner to your documentation to make it easy for readers to author new changes.
Remove links from top-right corner¶
The only way to remove these links currently is to override the Read the Docs theme templates:
- In your Sphinx project path, create a directory called
_templates
. If you use a differenttemplates_path
option in yourconf.py
, substitute that directory name. - Create a file in this path called
breadcrumbs.html
The new breadcrumbs.html
should look like this:
{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}
{% block breadcrumbs_aside %}
{% endblock %}