faq.rst

Часто задаваемые вопросы

Как добавить подпись к рисунку?

Смотрите раздел img-label.

Как добавить подпись к таблице?

Смотрите раздел table-label.

Как сделать ссылку на главу или раздел?

Ссылки на разделы внутри одного документа делаются путем указания в обратных кавычках названия этого раздела, например, Как сделать ссылку на главу или раздел?. :

... например, `Как сделать ссылку на главу или раздел?`_

Для создания ссылок между разными документами смотрите раздел cross-ref-label.

Как вставить содержание в разделе (документе)?

Смотрите раздел rst-cont-label.

Как сделать перекрестную ссылку на таблицу или рисунок?

Смотрите раздел cross-ref-label.

Как сделать перекрестную ссылку в виде категории?

Смотрите раздел ltx-refs-label.

Вставка графиков

Для вставки графиков используются дополнительные расширения, список которых приведен на странице Sphinx Extensions официальной документации Sphinx.

Также смотрите раздел ext-label.

Как настроить автоматическую генерацию документации

Подробнее смотрите раздел sphinx-autobuild-label и auto-pub-label.

Как сделать принудительный разрыв строки?

Возникла у меня необходимость сделать принудительный разрыв строки в HTML. Для этой цели используется автозамена и директива raw: :

.. |br| raw:: html

   <br />

Длинная строка с разрывом в |br| этом месте.

Длинная строка с разрывом в этом месте.

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

Смотрите статью reStructuredText (ReST): Быстрый способ ввода таблиц