Вопросы по теме 'read-the-docs'
python readthedocs, как удовлетворить требование sip (или pyqt)
Я хочу опубликовать документацию моего проекта https://bitbucket.org/oaltun/opn в readthedocs. орг.
Сборка не удалась. В журнале отображаются различные ошибки https://readthedocs.org/builds/opn/2247789/ , но первый - «нет модуля с именем sip»....
442 просмотров
schedule
05.05.2022
Есть ли способ предварительно собрать файлы .rst, сгенерированные autodoc, в Sphinx
У меня есть проект, для которого я создал набор файлов .rst с sphinx.ext.apidoc , который извлекает документацию из строк документации моего проекта.
Эти файлы выглядят следующим образом:
Submodules
----------
.. toctree::...
385 просмотров
schedule
14.02.2023
Защита паролем документации readthedocs.org
У меня есть документация на readthedocs.org. Есть ли способ защитить паролем или, по крайней мере, сделать нашу документацию доступной только для некоторых наших клиентов?
1171 просмотров
schedule
01.02.2023
readthedocs и setuptools неверная версия scm
У меня есть пакет, который я только что обновил, чтобы использовать setuptools_scm, и обнаружил, что номер версии неверен в readthedocs.
http://sshuttle.readthedocs.org/en/v0.77/ показывает:
Version: 0.78.dev0+ng083293e.d20160304
однако,...
1326 просмотров
schedule
29.03.2022
Удаление ссылки Edit on Github при использовании Read The Docs & Sphinx с темой ReadTheDocs
Я пытаюсь выяснить, как использовать параметр переопределений _template в Sphinx, чтобы переопределить тему ReadTheDocs по умолчанию для размещения документации Sphinx на http://readthedocs.org .
В частности, я хочу удалить / скрыть ссылку...
1837 просмотров
schedule
17.12.2022
использование tfvc с помощью readthedocs
Я рассматриваю возможность создания собственного экземпляра readthedocs. Я вижу, что у них есть поддержка Git, Mercurial, Subversion и CVS. Однако у меня есть пара устаревших проектов, которые требуют значительных усилий для перехода на git, сидящих...
93 просмотров
schedule
13.09.2023
Читать документацию Подключение к Bitbucket
У меня проблема. Я установил Read The Docs вручную, но когда я пытаюсь подключиться к битбакету, я получаю сообщение об ошибке:
DoesNotExist at /accounts/bitbucket_oauth2/login/
enter code hereSocialApp matching query does not exist.
Request...
304 просмотров
schedule
24.04.2024
Как я могу проверить, как часто посещалась моя страница readthedocs?
Я размещаю проект на github и использую Sphinx и RTD для автоматического преобразования и отображения моих документов в RTD.
Как добавить счетчик посещений страницы на мою страницу RTD?
237 просмотров
schedule
22.12.2022
Как перенаправить веб-страницы readthedocs на другой сайт
Мы начали размещать документы нашего проекта на сайте readthedocs (например, http://abc.readthedocs.org ). По разным причинам мы перешли на наши собственные веб-серверы с новым доменом ( http://abc.io ).
Мы хотим аккуратно отключить...
625 просмотров
schedule
16.02.2023
sphinx autodoc для python ничего не показывает (в readthedocs)
У меня есть этот пакет python , который я хотел бы автоматически документировать с помощью Sphinx. Я вставил строки документации во все функции и классы.
Я создал учетную запись на ReadTheDocs и сделал соответствующую настройку (т.е. каталог...
1218 просмотров
schedule
27.09.2022
Сбои сборки на случайной основе в readthedocs
Кажется, есть странная проблема с Readthedocs. Сборки терпят неудачу без видимых причин. С тем же идентификатором коммита сборка не удалась один раз, а позже была успешной:
Ошибка: https://readthedocs.org/projects/opnfvdocsdemo/builds/4909528/...
65 просмотров
schedule
01.04.2024
Предотвращение полужирного текста в ссылках для скачивания в Sphinx Read the Docs
Во время документирования библиотеки Python с использованием Sphinx и темы RTD я связывал некоторые PDF-файлы для загрузки, используя роль :download: Download Text <_download/the_file.pdf> , но по какой-то причине это приводит к ссылкам,...
295 просмотров
schedule
06.01.2023
Ошибка сборки readthedocs с использованием aiohttp
Впервые с помощью readthedocs.
Во-первых, есть ли способ указать сборку с помощью python 3.6?
Моя последняя сборка находится здесь: https://readthedocs.org/projects/cfanalytics/builds/6772697/ , который использует python 2.7 для сборки, но...
49 просмотров
schedule
05.02.2024
Включить версии на боковой панели в sphinx, прочтите тему документов
Я хотел бы включить файл versions.html в боковую панель, но мне это не удалось.
Я пробовал добавить файл versions.html в ** для боковых панелей, это не дало результата:
html_sidebars = {
'**': ['versions.html']
}
Также как объявить...
2285 просмотров
schedule
30.01.2023
Неверный файл требований: путь docs / requirements.txt не существует
При обновлении документов в моем проекте с помощью ReadTheDocs я не внезапно начал получать эту ошибку:
Problem parsing YAML configuration. Invalid "requirements_file": path docs/requirements.txt does not exist
Что странно, так это то, что...
501 просмотров
schedule
12.01.2024
Удалите /en/latest из URL-адресов по умолчанию в readthedocs.org
Мне нравится сервис readthedocs.org.
Тем не менее, для некоторых проектов меня совершенно не волнуют разные стабильные и последние версии, и я ожидаю, что в обозримом будущем документация будет только на английском языке (извините).
Я согласен с...
92 просмотров
schedule
23.02.2024
нумерация toctree не отображается в записях внешних ссылок
В настоящее время я пишу техническую документацию с помощью Sphinx.
Я использую пронумерованное toctree. Когда я вставляю внешнюю веб-ссылку в toctree, отображаемая запись не содержит числа.
Для этого toctree:
.. toctree::
:numbered:...
178 просмотров
schedule
11.05.2022
Как убрать флаг doctest при сборке readthedocs?
Я опубликовал свой пакет Python и разместил документацию на readthedocs.
Я хочу знать, как удалить флаги doctest (например, doctest: +ELLIPSIS ) из документации:
https://camphr.readthedocs.io/en/doc-doctest/
Когда я создал документ на...
37 просмотров
schedule
22.06.2022
Несколько версий в самостоятельной документации Sphinx
Я пытаюсь создать документацию для самостоятельного проекта GitLab. Эта документация будет размещена на страницах GitLab и будет иметь разные версии. Благодаря этому ответу я понял, как разместить несколько версии на страницах GitLab.
Моя...
375 просмотров
schedule
02.01.2023
Могу ли я создать несколько PDF-файлов из одного и того же источника в readthedocs?
У меня есть много документации на сайте readthedocs, и я хотел бы иметь возможность использовать ее в виде двух отдельных файлов PDF. Я разделил содержимое каждого из них на два файла *.rst верхнего уровня ( formal.rst и informal.rst ), указал их...
49 просмотров
schedule
19.09.2022
