Сфинкс, reStructuredText показать / скрыть фрагменты кода

Question

Я документировал программный пакет, используя Sphinx и reStructuredText .

В моих документах есть несколько длинных фрагментов кода. Я хочу, чтобы их можно было скрыть по умолчанию с помощью маленькой кнопки «Показать / Скрыть», которая развернула бы их ( Пример ).

Есть ли стандартный способ сделать это?

Answer 1

Вам не нужна пользовательская тема. Используйте встроенную директиву container, которая позволяет вам добавлять пользовательские css-классы в блоки и переопределять существующую тему, чтобы добавить некоторый JavaScript для добавления функции show / hide.

Это _templates/page.html:

{% extends "!page.html" %}

{% block footer %}
 <script type="text/javascript">
    $(document).ready(function() {
        $(".toggle > *").hide();
        $(".toggle .header").show();
        $(".toggle .header").click(function() {
            $(this).parent().children().not(".header").toggle(400);
            $(this).parent().children(".header").toggleClass("open");
        })
    });
</script>
{% endblock %}

Это _static/custom.css:

.toggle .header {
    display: block;
    clear: both;
}

.toggle .header:after {
    content: " ▶";
}

.toggle .header.open:after {
    content: " ▼";
}

Это добавлено к conf.py:

def setup(app):
    app.add_stylesheet('custom.css')

Теперь вы можете показать / скрыть блок кода.

.. container:: toggle

    .. container:: header

        **Show/Hide Code**

    .. code-block:: xml
       :linenos:

       from plone import api
       ...

Я использую что-то очень похожее для упражнений здесь: https://training.plone.org/5/mastering_plone/about_mastering.html#exercises

Answer 2

Тема облачного сфинкса имеет пользовательскую директиву html-toggle, которая предоставляет переключаемые разделы. Цитировать с их веб-страницы :

Вы можете пометить разделы с помощью .. rst-class:: html-toggle, что сделает раздел по умолчанию разделенным на html, а ссылка на «показать раздел» будет справа от заголовка.

Здесь - ссылка на страницу демонстрации теста.

Answer 3

Я думаю, что самый простой способ сделать это - создать собственную тему Sphinx, в которой вы сообщаете определенным html-элементам о наличии этой функциональности.Небольшой JQuery мог бы пойти сюда далеко.

Если, однако, вы хотите иметь возможность указать это в вашей разметке reStructuredText, вам нужно либо

• получить такую ​​вещьвключается в сам Sphinx или
• реализует его в расширении Sphinx / documentstils ... и затем создает тему Sphinx, которая знает об этой функциональности.

Это будет немного больше работы, но даст вам больше гибкости.

Answer 4

Существует очень упрощенное расширение, обеспечивающее именно эту функцию: https://github.com/scopatz/hiddencode

Это работает довольно хорошо для меня.