Я пытаюсь автоматически создавать api-документы для большой базы кода Python с помощью Sphinx. Я пробовал использовать build_modules.py и sphinx-apidoc. С помощью любого из них я могу получить первые документы, успешно созданные в моем выходном...

Я хотел бы включить один из моих файлов в оглавление Sphinx только тогда, когда установлен определенный тег, однако очевидный подход не работает: .. toctree:: :maxdepth: 5 index core utils oec plotting install news...

В моей документации sphinx есть несколько второстепенных страниц, которые (конечно) должны быть частью toctree, но я не могу перечислить их в нужном месте. Если моя страница «раздела 3» выглядит так: .. toctree:: 3.3 3.4 3 ===== 3.1...

Я новичок в Sphinx и некоторое время искал решение этого вопроса. Моя индексная страница сделана из index.rst, который содержит toctree. Страница отображает оглавление как в теле, так и на боковой панели. Я хотел бы показать оглавление ТОЛЬКО на...

У меня есть 2 первых файла: folder: |_file1.rst |_file2.rst file1.rst: .. toctree:: :maxdepth: 3 Name1 ======== Name2 ======== file2.rst: .. toctree:: :maxdepth: 3 Name3 ========= Name4 ========= Как сделать...

Хорошо, я использую Sphinx Autosummary для создания документации для некоторых классов. Есть три разных типа классов, и я хочу, чтобы моя боковая панель имела три отдельных раздела, как если бы я использовал параметр: caption: в директиве toctree....

Я пытаюсь использовать sphinx.ext.autosummary документировать пакет Python. Поскольку «автосводка» требует, чтобы мы перечислили все элементы, которые должны быть включены, я хотел указать их с помощью Jinja2. Мой conf.py выглядит следующим...

Пытаюсь создать документацию с помощью Sphinx. Первое использование: sphinx-apidoc Затем использование: sphinx-build html И я получил это предупреждение о файле modules.rst . Файл существует, html тоже сгенерирован, он определенно выглядит...

Я пытаюсь использовать основы Sphinx для документирования небольшого проекта. Но я не могу заставить его найти файлы, которые находятся в каталоге выше. Структура проекта следующая: / Пользователи / машина / рабочая область / проект1 ├──...