Удаление ссылки Edit on Github при использовании Read The Docs & Sphinx с темой ReadTheDocs

Я пытаюсь выяснить, как использовать параметр переопределений _template в Sphinx, чтобы переопределить тему ReadTheDocs по умолчанию для размещения документации Sphinx на http://readthedocs.org.

В частности, я хочу удалить / скрыть ссылку «Редактировать на Github», показанную в правом верхнем углу этой темы.

Будем признательны за любые советы! Спасибо!

Я просмотрел документацию здесь: http://www.sphinx-doc.org/en/stable/templating.html, однако я в тупике и действительно нуждаюсь в помощи.

Спасибо!


python-sphinx read-the-docs
person Brian King    schedule 15.03.2016    source источник

Ответы (3)


arrow_upward
12
arrow_downward

Хорошо, я понял это, поэтому отвечу на свой запрос в надежде помочь другим.

Предполагая, что вы используете тему по умолчанию ReadTheDocs, это должно работать нормально.

  • Клонируйте тему ReadTheDocs из репозитория Github на свой компьютер. (https://github.com/snide/sphinx_rtd_theme/)
  • Найдите breadcrumbs.html файл (https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html)
  • Добавьте breadcrumbs.html файл в папку документации Sphinx в папке _templates. Если этот каталог еще не существует, вам нужно его создать.

  • В вашем conf.py файле найдите свой html_context раздел. Если у вас его еще нет, вы можете создать его. (Образец указан ниже).

    html_context = { "display_github": False, # Add 'Edit on Github' link instead of 'View page source' "last_updated": True, "commit": False, }

  • Добавьте файл breadcrumbs.html к отслеживаемым файлам, используя Git

  • Зафиксируйте изменения в своем conf.py
  • Отправить в удаленное репозиторий Github
  • Выгода

использованная литература

person Brian King    schedule 19.04.2016

arrow_upward
1
arrow_downward

В документации для чтения документов есть аналогичные инструкции: https://docs.readthedocs.io/en/latest/guides/remove-edit-buttons.html#. Так что, возможно, с момента публикации исходного ответа были внесены изменения в основной код.

person Monique Semp    schedule 13.09.2018

arrow_upward
1
arrow_downward

Мои потребности были очень похожи, но не совсем одинаковы. Я хотел как удалить эту ссылку для сгенерированных страниц («поиск» и «гениндекс»), так и изменить текст ссылки, потому что мы используем framagit в качестве хостинга проекта.

Вот моя версия в конце:

{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}

{% block breadcrumbs_aside %}
  <li class="wy-breadcrumbs-aside">
    {% if hasdoc(pagename) and pagename != "search" and pagename != "genindex" %}
      <a href="{{ meta['framagit_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on FramaGit') }}</a>
    {% endif %}
  </li>
{% endblock %}

Посмотреть в прямом эфире можно здесь: https://framagit.org/simgrid/simgrid/tree/master/docs/source

person Martin Quinson    schedule 24.05.2019