Описание тега toctree
Используйте этот тег для вопросов о директиве toctree Sphinx. Эта директива используется для соединения файлов документации, других ветвей и оглавлений.
1
ответ
Sphinx не генерирует содержание боковой панели для заголовков
Я борюсь с оглавлением боковой панели в сгенерированной документации Sphinx. Я просто хочу иметь вид автоматически сгенерированного дерева индексов слева от моей документации. Вместо этого я вижу только пустые заголовки: (Надеюсь, вы не против, целе…
12 дек '18 в 14:32
8
ответов
Может ли sphinx ссылаться на документы, которые не находятся в каталогах под корневым документом?
Я использую Sphinx для документирования не-Python проекта. Я хочу раздать ./doc папки в каждом подмодуле, содержащие submodule_name.rst файлы для документирования этого модуля. Затем я хочу добавить эти файлы в основную иерархию, чтобы создать специ…
17 апр '12 в 21:12
3
ответа
Предотвращение вложенности подразделов в Python Sphinx при использовании toctree
Я столкнулся с проблемой в структурировании моего руководства пользователя Sphinx. Я хотел бы сформировать главу, имея главную целевую страницу (index.rst), которая содержит заголовок главы и обзор, а затем отдельные подразделы, содержащиеся в разны…
13 авг '14 в 00:48
4
ответа
Как развернуть все подразделы на боковой панели toctree в Sphinx
Мне было интересно, если есть способ расширить все подразделы под заголовками, которые включены в index.rst файл? В качестве примера, вот как это выглядит: Section 1 Section 2 Section 3 И вот как я бы хотел, чтобы это было: Section 1 Subsection 1.1 …
23 янв '13 в 10:25
1
ответ
Sphinx добавляет заголовки из файла разметки в структуру документа
Я настроил Sphinx для использования файлов уценки. В моем файле index.rst у меня есть .. toctree:: :maxdepth: 2 :caption: Contents: documents/Markdown В Markdown.md у меня есть # Markdown ## H2 Heading Когда я отображаю главную страницу, в заголовке…
21 фев '19 в 05:50
4
ответа
Как включить тектри в боковую панель каждой страницы
Я генерирую HTML документацию в Sphinx. Как мне изменить боковую панель для каждой html-страницы в моем документе, чтобы они включали toctree? По умолчанию токтриное дерево отображается только в master_doc страницы, и только в основной области вмест…
23 сен '13 в 21:19
5
ответов
ВНИМАНИЕ: документ не включен ни в одно дерево для включенного файла
Я получаю предупреждение: WARNING: document isn't included in any toctree для файлов, которые существуют в документе, потому что они были явно включены. Итак, у меня есть индексный файл: .. toctree:: :maxdepth: 2 pages/0010-foo pages/0020-bar В файл…
06 мар '13 в 14:02
1
ответ
Используйте Sphinx рекурсивно для автоматического создания документации API
Я хочу использовать автоматическое расширение Sphinx и шаблоны для рекурсивной генерации документов API из строк документации. Я хочу отдельные страницы для каждого модуля, класса, метода, свойства и функции. Но он не обнаруживает мои шаблоны вообще…
03 янв '18 в 08:57
1
ответ
Добавление подразделов self в оглавление
У меня возникла проблема с получением оглавления (TOC) для отображения подразделов первой страницы моей документации. У меня есть несколько разделов на моей первой странице, и я хотел бы, чтобы они отображались в оглавлении. Отображение подраздела о…
18 дек '13 в 03:03
1
ответ
Боковая панель сфинкса
Я пытаюсь создать новый шаблон Sphinx, который бы создал пользовательское дерево для боковой панели. Используя язык шаблонов Jinja, кажется, доступна только одна функция: toctree() который отображает все toctree одновременно, но мне нужно перебрать …
31 июл '15 в 13:59
1
ответ
Как создать файл sitemap.xml с помощью sphinx?
Здесь говорится: "Специальное имя записи self обозначает документ, содержащий директиву toctree. Это полезно, если вы хотите сгенерировать" карту сайта "из toctree". И я смотрю на этот thred - Использование self для создания карты сайта с toctree в…
29 апр '15 в 17:58
2
ответа
Не удается включить ноутбук с nbsphinx
Я новичок в sphinx, и я хочу написать документацию пакета Python. У меня проблема, когда я хочу включить демонстрационный файл. Я хочу включить файл demo.ipynb, используя расширение nbsphinx. Он успешно установлен на моем компьютере. Переменная exte…
22 мар '19 в 10:18
0
ответов
Сфинкс (RTD Theme) раздел навигации не соответствует
Мой вопрос трудно передать словами. Я буду стараться изо всех сил. Используя Sphinx 2.0.0, у меня есть проект со следующим "корневым" тектрием. Это индекс toctree: Welcome to FIRST Robotics Documentation =============================================…
22 апр '19 в 04:33
0
ответов
Разное:maxdepth: для определенных записей в toctree (Sphinx)
У меня есть некоторая документация на основе Sphinx для библиотеки, которую я построил, и я хотел бы показать расширенное оглавление для всех моих страниц, кроме журнала изменений. Я разобрался, как это сделать, переместив журнал изменений на секунд…
18 май '19 в 03:32
0
ответов
Пользовательская нумерация разделов в Сфинксе
Я хотел бы иметь другую нумерацию для Сфинкса: i, ii, iii для frontmatter 1., 1.1, 2. для основного контента A., B.... для приложения Нумерация происходит от :numbered: вариант в .. toctree:: директивы. Это как-то связано с assign_section_numbers ме…
30 июл '19 в 15:21
1
ответ
Как включить в токос sphinx как внешние файлы, так и разделы из индекса?
Я создаю свою документацию по пакету python с помощью sphinx, но у меня возникли проблемы с добавлением в оглавление обеих записей из других файлов в папке docs и других разделов, присутствующих в index.rst. Это содержимое моей папки с документами: …
09 ноя '19 в 18:07
1
ответ
Одинаковый уровень в дереве дерева и панели навигации с отдельными файлами
Я хочу отделить иерархию файлов от иерархии документов, я хочу иметь четыре раздела одного уровня в разных файлах, два в одном файле и два в отдельных файлах, в конце я хочу, чтобы токтри ссылались на них в одном и том же уровень. main.rst main ====…
08 ноя '19 в 16:19
0
ответов
Как отображать только заголовки .rst в боковой панели навигации Sphinx?
Я создаю документацию в Sphinx, используя эту тему: https://github.com/romnnn/sphinx_press_theme У меня возникают проблемы с отображением намеченной боковой панели навигации, которая в идеале должна отражать заголовки каждого из моих .rst файлы - на…
09 апр '20 в 15:59
1
ответ
Как добавить подписи в Sphinx toctree без добавления новых документов?
Хорошо, я использую Sphinx Autosummary для создания документации для некоторых классов. Есть три разных типа классов, и я хочу, чтобы моя боковая панель имела три отдельных раздела, как если бы я использовал параметр: caption: в директиве toctree. И…
13 дек '19 в 20:07
1
ответ
Использование Jinja2 с автосводкой Sphinx
Я пытаюсь использовать sphinx.ext.autosummary для документирования пакета Python. Поскольку "автосводка" требует, чтобы мы перечислили все элементы, которые должны быть включены, я хотел указать их с помощью Jinja2. Мой conf.py выглядит следующим об…
19 дек '19 в 17:30