Вопросы по теме 'read-the-docs'

Несколько уровней Toctree в Python-Sphinx
Я пытаюсь использовать sphinx для документирования нескольких «уровней» документации, например: Ссылка на API Руководство по эксплуатации Учебники И т.п. Идея состоит в том, что оглавление отображается на боковой панели относительно...
4984 просмотров
python sidebar python-sphinx read-the-docs toctree
schedule 18.08.2022
Можно ли загрузить предварительно созданные html-документы sphinx на сайт ReadTheDocs?
У меня есть проект python-3, который использует plot-directive , но в настоящее время не поддерживается ReadTheDocs . Поэтому я хочу сгенерировать и загрузить документы, как обычно делаю с репозиторием PyPi, но использую параметр -r , чтобы...
790 просмотров
python matplotlib pypi python-sphinx read-the-docs
schedule 06.04.2023
Показать все toctree на боковой панели Read The Docs
Насколько я понимаю, новая тема Read The Docs генерирует боковую панель из toctree с глубиной 2. Моя документация относительно глубокая, и глубины 2 недостаточно, чтобы она была полезной. Как я могу увеличить этот лимит или, что лучше, полностью...
7517 просмотров
python sidebar python-sphinx read-the-docs toctree
schedule 28.08.2022
Как настроить несколько документов Sphinx в одном проекте в ReadTheDocs?
Я хотел бы использовать ReadTheDocs для размещения моей документации по Sphinx. Проект размещен на github. Я могу подключиться к нему нормально. Особенность, которая у меня есть, заключается в том, что проект содержит 2 документа Sphinx...
2004 просмотров
github python-sphinx read-the-docs
schedule 19.11.2023
Мок с подмодулями для ReadTheDocs
Я пытаюсь задокументировать проект Python с помощью ReadTheDocs. Изначально процесс сборки умирал, когда доходил до: from osgeo import gdal, osr Я прочитал rtd faq и использовал mock для модуля osgeo, который доставлял мне проблемы....
558 просмотров
python mocking read-the-docs
schedule 20.08.2022
Прочитать сборку Документов не удалось без ошибок?
Недавно я начал использовать Read The Docs , и все прошло очень гладко. Сегодня я попытался создать ветку разработки моего проекта на Read The Docs. Сборка не удалась. После нескольких часов отладки я вернулся к неизмененной основной ветке и...
865 просмотров
python read-the-docs
schedule 02.12.2023
Делаем расширение сфинкса, которое складывает секции в теле
Я пытаюсь сделать расширение в Sphinx, идея будет заключаться в том, что расширение определяет заголовок разделов, а затем преобразует их в раздел fold, т.е. что sphinx отображает заголовок с кнопкой префикса, которая помогает отображать или не...
402 просмотров
python python-sphinx read-the-docs docutils
schedule 26.08.2022
Как структурировать документы Sphinx для большого количества модулей
Как мне лучше всего структурировать документы Sphinx (для чтения документов), если мне нужно поддерживать как «обычную» прозаическую документацию, так и документацию по API для 30+ модулей? Есть ряд (‹10) обычных страниц документации, таких как...
1155 просмотров
python-sphinx read-the-docs
schedule 23.05.2023
Отключить/изменить короткую ссылку readthedocs
Я создал контейнерную установку readthedocs. До сих пор доволен, однако я вижу, что он создает короткие URL-адреса на странице проекта. К сожалению, короткие URL-адреса не существуют в DNS, поэтому никуда не ссылайтесь. Например, они отображаются...
70 просмотров
read-the-docs
schedule 30.07.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
Значок ReadTheDocs красный на Github, но должен быть зеленым
Изменить Значок теперь отображается зеленым цветом и на GitHub. Может ли это быть связано с кешированием GitHub? Редактировать 2 О, он снова красный. Значок в проекте ReadTheDocs здесь имеет зеленый цвет. Но когда я...
430 просмотров
github markdown read-the-docs
schedule 14.07.2022
sphinx - несколько файлов в главе и чистая html-навигация с rtd-темой возможна?
Я использую sphinx 1.3.4¹ для написания документации, make html использует тему «читать документы »². Когда я включаю в этот документ файл chaper1.rst в index.rst с заголовками от уровня 1 до уровня 3, я вижу заголовок lv 1 в моей результирующей...
521 просмотров
python navigation python-sphinx read-the-docs
schedule 10.04.2022
использование Doxygen в документации для чтения
Я написал документацию для программного обеспечения C++ среднего размера, используя Doxygen вместе с Markdown. Я вполне доволен этим, так как после изменения слоя xml я получил что-то вроде этого: http://docs.mitk.org/nightly/index.html Я хотел...
7265 просмотров
read-the-docs doxygen
schedule 19.03.2022
Как я могу связать / сослаться на другой файл reST в документации?
Я просто не знаю, как связать другой документ в файле reST. Я хочу связать файл с именем install.rst с моим кратким руководством в абзаце. Я не знаю, как мне этого добиться. Не могли бы вы также обратиться к отличному ресурсу, где я могу...
37437 просмотров
python-sphinx read-the-docs restructuredtext
schedule 22.11.2023
Могу ли я создавать и размещать собственные HTML-страницы в Read the Docs?
Документация по моей программе в основном написана на Sphinx , но она также включает две пользовательские HTML-страницы: пример отчета , созданный программой; расширенный справочник по определенным функциям программы. Эти два файла...
414 просмотров
python read-the-docs
schedule 27.06.2022
Почему ReadTheDocs не показывает дату последнего обновления
У меня есть документация , подготовленная и размещенная на ReadTheDocs. Он по-прежнему показывает хэш коммита Git вместо строки «Последнее обновление», тогда как в моей локальной HTML-документации указана сегодняшняя дата. Локальная версия:...
411 просмотров
python-sphinx read-the-docs configuration-files
schedule 17.12.2023
Почему мой проект ReadTheDocs не импортируется?
У меня уже почти год есть проект, который импортирует и использует ReadTheDocs. Спустя некоторое время без обновлений я решил, что пришло время восстановить документы. Однако теперь сборка завершается сбоем с не очень информативной ошибкой:...
88 просмотров
svn read-the-docs
schedule 22.11.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
Изменение sys.path для чтения документов
Я документирую свой проект пирамиды локально с помощью sphinx. Локально autodoc работает нормально и документация выглядит так, как я хочу. Но если я использую read the docs, я получаю следующую ошибку при каждом использовании функции autodoc:...
1341 просмотров
python python-sphinx read-the-docs sys.path
schedule 27.03.2023
Автоматически сгенерированный индексный файл в readthedocs
Мне не удается загрузить в readthedocs документацию, подготовленную для моего проекта, и я пытаясь понять, что не так. Документация отлично строится локально с помощью make html , но я не могу ее загрузить. Проект GitHub называется...
374 просмотров
github svn read-the-docs
schedule 22.11.2022