Skip to content
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

Mention "Hosted on Read the Docs" in the footer #1616

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Mention "Hosted on Read the Docs" in the footer #1616

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb0b44d
Mention "Hosted on Read the Docs" in the footer
humitos Oct 8, 2024
14d07f9
Remove one of the links
humitos Oct 8, 2024
5524c22
Merge branch 'master' into humitos/hosted-on-readthedocs
humitos Oct 30, 2024
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
7 changes: 5 additions & 2 deletions sphinx_rtd_theme/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,16 @@

{% if show_sphinx %}
{%- set sphinx_web = '<a href="https://www.sphinx-doc.org/">Sphinx</a>' %}
{%- set readthedocs_web = '<a href="https://readthedocs.org">Read the Docs</a>' %}
{#- Translators: the variable "sphinx_web" is a link to the Sphinx project documentation with the text "Sphinx" #}
{%- trans sphinx_web=sphinx_web, readthedocs_web=readthedocs_web %}Built with {{ sphinx_web }} using a{% endtrans %}
{#- Translators: "theme" refers to a theme for Sphinx, which alters the appearance of the generated documentation #}
<a href="https://github.com/readthedocs/sphinx_rtd_theme">{% trans %}theme{% endtrans %}</a>
{#- Translators: this is always used as "provided by Read the Docs", and should not imply Read the Docs is an author of the generated documentation. #}
{% trans %}provided by {{ readthedocs_web }}{% endtrans %}.
{% trans %}provided by Read the Docs{% endtrans %}.
{% endif %}

{% if READTHEDOCS %}
Hosted on <a href="https://about.readthedocs.com/">Read the Docs</a>.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be wrapped by show_sphinx or a specific configuration option. If the user selected show_sphinx = False, they will probably not like that we injected different content in the same space.

{% endif %}

{%- block extrafooter %} {% endblock %}
Expand Down