Несколько версий в собственной документации Sphinx - PullRequest
1 голос
/ 02 марта 2020

Я пытаюсь собрать документацию для собственного проекта GitLab. Эта документация будет размещена на страницах GitLab и будет иметь разные версии. Благодаря этому ответу я понял, как разместить несколько версий на страницах GitLab.

Моя проблема сейчас заключается в том, как получить доступ к этим версиям.

Я хотел бы использовать тема ReadTheDocs, которая, кажется, была создана с учетом этого:

rtd collapsible menu

Как я могу получить доступ и изменить это меню навигации? Я ничего не смог найти в документации.

( Редактировать: Только что узнал, что это меню выпадающее меню )

Если это было невозможно, я бы хотел как-то добавить раздел на левой панели (например, html_sidebars на тему classi c), поскольку я уже создал скрипт для получения ссылок на версии.

Мне действительно нужен способ добавить раздел в панель.

Спасибо!

1 Ответ

0 голосов
/ 04 марта 2020

Мое решение

Поскольку @Steve Piercy упомянул в комментарии, что всплывающее окно в теме собственного размещения RTD невозможно, я попытался персонализировать левую боковую панель, чтобы добавьте ссылки на версии.

В отличие от темы classi c (с упомянутой мною html_sidebars), похоже, нет способа настроить отображаемое. То, что вы можете сделать, это добавить настроенные javascript и css. Поэтому я создал небольшой скрипт, который добавляет новый неупорядоченный список со ссылками на версии вверху c.

. Я бы предпочел использовать другой подход, поскольку он хакерский и использует жестко закодированный css имена классов (которые могут измениться в любой момент), но это единственное, что я могу придумать и работать нормально.

Если кому-то понадобится более подробная информация о решении, я могу предоставить их.

...