Вопросы по теме 'toctree'

Может ли сфинкс ссылаться на документы, которые не находятся в каталогах ниже корневого документа?
Я использую Sphinx для документирования проекта, отличного от Python. Я хочу распределить ./doc папки в каждом подмодуле, содержащие submodule_name.rst файлы для документирования этого модуля. Затем я хочу засунуть эти файлы в главную иерархию,...
40200 просмотров
python symlink python-sphinx toctree
schedule 27.02.2022
Явное название токтрия в Сфинксе
Я пытаюсь явно указать заголовок элемента в моем toctree . В документации сказано, что это должно быть так: .. toctree:: All about strings <string> Но он просто печатает заголовок того, что находится в документе string.rst, а не...
354 просмотров
python python-sphinx toctree
schedule 02.01.2023
Не удается получить TOCTREE в Sphinx для отображения ссылки
Я новичок в Sphinx. Я попробовал учебник, но мне не удалось создать ссылку в содержании. Ошибка, которую я получил C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe rence to document 'intro' that doesn't have a...
9279 просмотров
python python-sphinx toctree
schedule 20.01.2023
ВНИМАНИЕ: документ не включен ни в одно дерево для включаемого файла
Получаю предупреждение: WARNING: document isn't included in any toctree для файлов, которые существуют в документе, потому что они были явно включены. Итак, у меня есть индексный файл: .. toctree:: :maxdepth: 2 pages/0010-foo...
42880 просмотров
python-sphinx toctree restructuredtext
schedule 27.10.2022
Использование self для создания карты сайта с toctree в сфинксе кажется сломанным?
Я обновляю FAQ для довольно большого проекта, и я хотел бы добавить указатель вопросов вверху страницы, чтобы пользователям было легче находить то, что они ищут. В статье о toctree документации Sphinx говорится: «Специальное имя записи self...
1596 просмотров
sections tableofcontents python-sphinx toctree
schedule 26.02.2023
Нумерация разделов Sphinx для заголовков более чем 3 уровня: .. sectnum ::
Я использую Sphinx для создания файлов PDF из первых файлов. Sphinx автоматически генерирует номера разделов до заголовков уровня 3, а также Таблицу содержания до этого уровня. Однако я хочу, чтобы заголовки на всех уровнях были пронумерованы и...
8321 просмотров
sections python-sphinx toctree restructuredtext
schedule 06.11.2022
autosummary с toctree также выводит список импортированных членов
Я использую Sphinx и autosummary для создания документации программного обеспечения Python. Он работает хорошо, но в созданных файлах .rst также перечислены импортированные функции и классы, чего я бы не хотел. Например, пакет packageex со строкой...
2716 просмотров
python python-sphinx toctree
schedule 16.06.2022
Несколько уровней Toctree в Python-Sphinx
Я пытаюсь использовать sphinx для документирования нескольких «уровней» документации, например: Ссылка на API Руководство по эксплуатации Учебники И т.п. Идея состоит в том, что оглавление отображается на боковой панели относительно...
4984 просмотров
python sidebar python-sphinx read-the-docs toctree
schedule 18.08.2022
Показать все toctree на боковой панели Read The Docs
Насколько я понимаю, новая тема Read The Docs генерирует боковую панель из toctree с глубиной 2. Моя документация относительно глубокая, и глубины 2 недостаточно, чтобы она была полезной. Как я могу увеличить этот лимит или, что лучше, полностью...
7517 просмотров
python sidebar python-sphinx read-the-docs toctree
schedule 28.08.2022
Как сделать так, чтобы ссылка toctree ссылалась на отдельный файл так же, как она ссылается на подразделы
Структура Следующая структура проекта: index.rst MyProject ========= Contents: .. toctree:: group1 group1.rst Group1 ------ Subgroup1 ========= Subgroup1 contents Subgroup2 ========= Subgroup2 contents...
3242 просмотров
sidebar python-sphinx read-the-docs toctree restructuredtext
schedule 15.07.2022
Создавайте дубликаты шаблонов с разными навигационными цепочками при ссылке на разные toctrees
Структура моего документа выглядит так: ├── common │   └── shared.rst ├── foo │   └── foo.rst ├── index.rst └── zoo └── zoo.rst Сгенерированная структура выглядит так: ├── common │   └── shared.html (breadcrumbs: home -> zoo ->...
45 просмотров
breadcrumbs tableofcontents python-sphinx toctree
schedule 08.09.2022
Автоматически создавать toctree для классов autodoc в Sphinx
Я хочу расширить документацию в одной из моих библиотек. Я использовал sphinx для создания документации и недавно начал изучать расширение autodoc. Кажется, что в большинстве профессиональных документов на каждой странице документации по классам...
5486 просмотров
python python-sphinx autodoc toctree
schedule 16.02.2023
Sphinx toctree, автомодуль всего html на одной странице
Я использую Sphinx для документирования моего проекта Python. Моя проблема заключается в том, что все мои файлы python в таблице содержания перечислены на одной странице. Это то, что у меня есть до сих пор. Я бы хотел, чтобы Python_file_1,...
1147 просмотров
python html python-sphinx toctree
schedule 06.01.2023
Как вставить обложку в вывод latexpdf в Sphinx
Мы рассматриваем возможность использования Sphinx там, где я работаю, и, похоже, он делает все, что нам нужно. Однако у меня возникают проблемы с тем, чтобы он соответствовал требуемому корпоративному шаблону, который требует, чтобы между титульной...
510 просмотров
pdf-generation tableofcontents python-sphinx pdflatex toctree
schedule 23.02.2023
Autosummary с toctree не создает документацию для методов
Я использую sphinx с расширением numpydoc и автосуммированием. После некоторых экспериментов я добавил следующие параметры в свой файл conf.py. autosummary_generate = True numpydoc_show_class_members = False Это дает мне новый файл для...
2792 просмотров
python python-sphinx autodoc toctree numpydoc
schedule 26.07.2023
Можно ли смешивать внешние ссылки и включения в toctree (по заказу)?
Мне нужно включить содержимое страницы и некоторые внешние ссылки в toctree документации по сфинксу в правильном порядке. Предположим, это моя структура: ======= Test ======= .. toctree:: :hidden: Test...
200 просмотров
python-sphinx toctree
schedule 29.07.2022
Почему toctree не обновляется с помощью темы RTD?
У меня есть программно сгенерированный источник sphinx-doc, который использует тему Read-The-Docs. Исходное дерево выглядит так: source ├── conf.py ├── index.rst ├── models │   ├── 1lin │   │   ├── 1lin_Amplero.rst │   │   ├── 1lin_Blodgett.rst │...
635 просмотров
makefile python-sphinx autodoc read-the-docs toctree
schedule 03.05.2023
Sphinx не распознает вложенные папки
Я новичок в использовании Sphinx . Я могу создавать HTML-документацию, пока мои файлы находятся в source верхней папке. Как только я помещаю их в подпапку в source directory , Sphinx не включает документ в сборку. Sphinx сообщает мне...
4775 просмотров
python python-sphinx autodoc toctree
schedule 19.05.2023
Удалить лишнее toctree с боковой панели в sphinx
Изменить: этот другой пост кажется связанным Я использую расширение fulltoc для отображения оглавления на боковой панели. Глобальное оглавление определяется в глобальном файле index.rst. На самом деле он состоит из серии toctree в...
601 просмотров
python sidebar python-sphinx toctree restructuredtext
schedule 02.12.2023
Изображение и оглавление рядом в реструктурированном тексте с python-Shinx
Я использую Sphinx, чтобы сделать хорошую документацию по своему коду, и я хотел бы знать, можно ли разместить изображение рядом с оглавлением (вместо большого пробела без чего-либо) На данный момент мой файл index.rst для начинающих выглядит так:...
965 просмотров
image python-sphinx toctree restructuredtext
schedule 13.06.2023