Вопросы по теме 'read-the-docs'
Есть ли закрытая версия readthedocs?
Я разрабатываю внутреннее приложение, которое является проприетарным, и я хочу создать и разместить документацию где-нибудь. Из-за того, что это частная собственность, я не могу использовать общедоступную версию readthedocs. Существует ли платная...
1665 просмотров
schedule
17.12.2022
Ошибка сфинкса в Readthedocs: TypeError: объект 'bool' не имеет атрибута '__getitem__'
Сборка документации на Readthedocs завершилась неудачно из-за ошибки Sphinx, которую довольно сложно понять:
Exception occurred:
File...
313 просмотров
schedule
06.05.2023
Поместите второстепенные страницы в нужное место в оглавлении
В моей документации sphinx есть несколько второстепенных страниц, которые (конечно) должны быть частью toctree, но я не могу перечислить их в нужном месте.
Если моя страница «раздела 3» выглядит так:
.. toctree::
3.3
3.4
3
=====
3.1...
107 просмотров
schedule
22.05.2022
Как опубликовать мой репозиторий github на readthedocs?
Для тестирования я создал библиотеку на github, адрес доступа: https://github.com/zibuyule/test2 . На readthedocs.org вошел в мою учетную запись github и собрал последнюю версию. На readthedocs.org мой адрес:...
146 просмотров
schedule
27.07.2023
RTD компилирует все мои документы, включая сторонние, из подмодулей git
Я экспериментирую с Sphinx и ReadTheDocs (RTD) для компиляции моей документации при каждом нажатии на GitHub. К сожалению, RTD обнаружил несколько _1 _ / _ 2_ папок, содержащих conf.py файл.
Мой репозиторий использует подмодули git для...
70 просмотров
schedule
27.03.2023
Sphinx: исключить кнопки «Далее» и «Назад»
Я хочу удалить кнопки Next и Prev . Из того, что я прочитал в документе, этого можно добиться, исключив relations.html ; однако я не уверен, как можно было бы добиться этого.
Я попытался добавить следующее к conf.py без особых изменений....
1246 просмотров
schedule
20.08.2022
Как удалить учетную запись Read the Docs (readthedocs.org)
Некоторое время назад я подписался на Read the Docs , но больше не хочу пользоваться этой услугой.
На моей странице настроек, похоже, нет опции «удалить учетную запись», и я ничего не могу найти в документация .
Есть ли способ удалить мою...
181 просмотров
schedule
24.04.2023
sphinx_rtd_theme не применяется к сборкам ReadTheDocs, но локальные сборки работают нормально
Я столкнулся со странной проблемой. Я добавил последние файлы sphinx_rtd_theme в свой проект и сделал необходимые переопределения темы (включая известный перенос текста в таблицах).
Локальная сборка работает абсолютно нормально. Но это было...
1103 просмотров
schedule
25.02.2023
Директива autodoc работает локально, но не в readthedocs
Мое репо находится на github здесь: https://github.com/AshleySetter/optoanalysis
И документы находятся в https://github.com/AshleySetter/optoanalysis/tree/master/optoanalysis/docs
ReadTheDocs не дает сбоев, но созданная документация...
303 просмотров
schedule
08.11.2022
Сбой сборки ReadTheDocs Sphinx, но работает локально
как следует из названия, сборка документов для моего пакета отлично работает локально, но не на сервере. Я получаю следующую ошибку:
Traceback (most recent call last): File...
250 просмотров
schedule
02.08.2023
Читать Документы PDF не содержит изображений
Я начал проект документации в Read the Docs, используя репозиторий GitHub. Я настроил его как проект Sphinx и использую Markdown в контенте. Основная причина этого — воспользоваться предварительным просмотром GitHub Markdown, который великолепен....
108 просмотров
schedule
05.11.2022
Как я могу заставить сборку readthedocs.org игнорировать мой файл require.txt?
У меня есть небольшой проект приложения на github, который работает в Windows и требует pythonnet .
Мой requirement.txt содержит:
beautifulsoup4==4.6
pythonnet==2.3
Теперь я подумал, что создам для него документацию и выложу на...
630 просмотров
schedule
20.08.2022
Sphinx добавляет индекс всего модуля в сгенерированный PDF
Я использую Sphinx autodoc для создания документации по Python, которая затем размещается в ReadTheDocs здесь . PDF-файл, созданный ReadTheDocs, содержит только оглавление моей индексной страницы, которое вы можете увидеть здесь .
Я хочу, чтобы...
631 просмотров
schedule
05.12.2022
Как протестировать репозиторий github mkdocs, созданный локально в Mac OS X?
Есть репозиторий GitHub, который мне нравится вносить изменения в его документы . Он использует readthedocs для размещения и mkdocs для темы.
Я использую macOS Мохаве.
Я нашел это https://docs.readthedocs.io/en/latest/install.html...
173 просмотров
schedule
11.07.2022
Подсветка синтаксиса nbsphinx в readthedocs
У меня есть документация readthedocs sphinx, которая использует nbsphinx для отображения ноутбуков jupyter. Когда я создаю документацию локально с помощью автосборки, у меня есть подсветка синтаксиса в ячейках кода в блокноте Jupyter. Но в...
115 просмотров
schedule
27.07.2023
Как добавить электронную таблицу в Read the Docs?
Как лучше всего добавить электронную таблицу в мою документацию с помощью Read the Docs?
Я работаю над проектом с открытым исходным кодом, который производит аппаратное и программное обеспечение с открытым исходным кодом. Вездесущий раздел...
134 просмотров
schedule
05.12.2022
Модули появляются, но не отображают функции в ReadTheDocs, без явных ошибок в Sphinx
Я работаю над документированием фрагмента кода с помощью ReadTheDocs (RTD). Вот репозиторий GitHub, который он создает, а ниже - текущее состояние веб-сайта:
Репо: https://github.com/GluonicPenguin/AutoDQM .
RTD:...
51 просмотров
schedule
22.06.2023
Как исправить ошибку Дублированная сборка на readthedocs?
На readthecods я пытаюсь создать проект, но получаю сообщение об ошибке
Error
Duplicated build.
Как решить эту проблему?
153 просмотров
schedule
17.01.2023
Строки документации не включены в сборку Read the Docs Sphinx.
Я создал документацию Sphinx, и эта сборка хорошо работает локально. Мои строки документации выглядят так, как показано ниже.
При переходе на readthedoc.io я добавил конкретный файл требований в docs/requirement.txt , а именно:...
109 просмотров
schedule
28.06.2022