Описание тега read-the-docs
Бесплатный хостинг документации для сообщества Open Source
0
ответов
Какой объем файловой системы рекомендуется для локальной установки службы readthedocs?
Я настраиваю локальную службу readthedocs, работающую в AWS, и у меня есть вопросы относительно требований к хранилищу. Все ли динамические ресурсы, такие как сборки документов, хранятся исключительно в базе данных? В настоящее время я создаю отдель…
04 сен '18 в 18:57
0
ответов
Readthedocs: модули Python с математическими выражениями не отображаются
У меня есть проект Python с некоторыми модулями, которые имеют строки документации с математическими выражениями. Я использую Sphinx 1.7.2 с расширением sphinx.ext.imgmath для создания документации в формате html, и все это отлично работает локально…
09 апр '18 в 18:51
2
ответа
Как сложить все разделы второго уровня в сфинксе?
Я использую тему readthedocs для личного проекта документации sphinx. Все работает нормально, кроме отображения левого фрейма списка содержимого: он отображает все уровни заголовков разделов, не показывая никакой иерархии. Как позволить этому показы…
06 фев '18 в 12:16
1
ответ
Добавление файлов в подпапках в документацию sphinx (sphinxcontrib-matlabdomain)
У меня есть каталог, содержащий различные папки, в каждой из которых есть исходные файлы Matlab. Некоторые из этих папок имеют подпапки, содержащие исходные файлы Matlab. Как создать дерево оглавления с помощью Sphinx для вложенных папок? Например, …
02 ноя '15 в 20:37
2
ответа
Делать расширение сфинкса, которое складывает участки тела
Я пытаюсь сделать расширение в Sphinx, идея состоит в том, что расширение определяет заголовок разделов, а затем преобразует их в раздел сгиба, то есть сфинкс отображает заголовок с помощью кнопки префикса, которая помогает отображать или не отображ…
05 окт '15 в 17:04
1
ответ
ImportError: Ни один модуль с именем 'pkg_resources' в сборках на readthedocs.org
Я начал создавать документы для моего проекта с readthedocs, и какое-то время он работал отлично, но теперь я получаю эту сумасшедшую ошибку: Collecting sphinx==1.3.5 Using cached Sphinx-1.3.5-py2.py3-none-any.whl Collecting Pygments==2.1.3 Using ca…
02 окт '16 в 01:34
2
ответа
Выравнивание по левому краю таблицы в сфинксе
Есть ли способ выровнять заголовки таблиц в выводе Sphinx (используя sphinx_rtd_theme)? Пользовательский CSS включен в conf.py: def setup(app): app.add_stylesheet('_static/custom.css') Это работает: .wy-nav-content { max-width: none; } Ни одна из эт…
23 окт '18 в 08:20
1
ответ
Не удалось прочитать сборку документов UnicodeDecodeError
Я нахожусь на https://readthedocs.org/, я пытаюсь собрать свой projet doc, написанный на python3. настройки: тип документации: сфинкс html язык программирования: питон использовать virtualenv интерпретатор Python: CPython 3.x это не удалось в: pytho…
09 фев '16 в 13:29
1
ответ
Читайте документы, поиск не работает
Я пытаюсь написать документацию, используя Sphinx в сочетании с темой read the docs, но функция поиска, похоже, не работает. Я использую Python 3.7 с последней версией Sphinx и темой Read the Docs (обе установлены с pip install) в Windows 10. После …
24 сен '18 в 07:04
1
ответ
Обратный прокси mkdocs nginx медленный
Я настроил mkdocs и запущен на порту 8000, Nginx настроен как обратный прокси с нижеприведенной конфигурацией. Однако при доступе к сайту через обратный прокси-браузер остается "подключенным..." в течение длительного времени, около 2 минут и загрузк…
09 окт '16 в 02:28
1
ответ
Ошибка импорта ReadTheDocs из __init__.py
У меня проблемы с readdhedocs autodocs - сборка завершена, но моя документация пуста для каждого класса. Глядя на информацию о сборке, кажется, что получает синтаксическую ошибку, которая вызывает несколько предупреждений: print(clean_sample, file=o…
27 апр '18 в 14:14
0
ответов
Складное меню в html readthedocs
Я создал проект для чтения документов. Когда я нажимаю "Свернуть меню", оно не работает. Помоги мне! пожалуйста! пример Я исправил это с помощью: html_theme_options = { 'collapse_navigation': False, }
19 сен '18 в 06:37
1
ответ
Последняя сборка не найдена
У меня на некоторое время был привязан мой проект "Читать документы", и я пытаюсь сейчас перенести все свои уценки, и, поняв, что веб-зацепки активны (я импортировал их, соединив аккаунты), и перестраивая его, я все равно получаю страницу 404, и я н…
11 июн '17 в 21:53
0
ответов
Как исправить ошибку сборки read-the-docs в старом выпуске
У меня есть проект на GitHub с одной главной веткой и несколькими помеченными релизами. Документация размещена на сайте Read The Docs. Полгода назад я выпустил версию 0.7.0, и документация была успешно собрана. После выпуска версии 0.8.0 сегодня я п…
09 май '17 в 18:19
0
ответов
Может ли Read-The-Docs генерировать документы API автоматически?
Я недавно удалил документы API из своего репозитория, потому что они обновляются каждый раз токсом, и я не думаю, что автодокументы должны быть в репозитории. В результате похоже, что у RTD возникают проблемы при создании документации по API проекта…
03 ноя '17 в 09:34
1
ответ
Мой `pdf`, сгенерированный через RTD, содержит все статьи контента в заголовке. Почему?
Я только недавно (вчера) начал использовать sphinx и читать документы для моего проекта. До сих пор я доволен HTML-документацией, но PDF-версия включает в себя все статьи, которые появляются в указателе в заголовке "Содержание". И содержимое / индек…
25 май '16 в 15:02
1
ответ
Оптимизация времени сборки проекта ReadTheDocs
Я разрабатываю двоичную библиотеку Python разумного размера, Parselmouth, для сборки которой требуется некоторое время - главным образом потому, что я обертываю существующую программу большой базой кода. Следовательно, теперь, когда я пытаюсь настро…
04 окт '17 в 17:16
0
ответов
Неудачные сборки в readthedocs
Кажется, с Readthedocs возникает странная проблема. Сборки терпят неудачу без видимой причины. При одном и том же идентификаторе фиксации сборка не удалась один раз, а позже была успешной Ошибка: https://readthedocs.org/projects/opnfvdocsdemo/builds…
19 янв '17 в 07:07
1
ответ
Удинг TFVC с readthedocs
Я рассматриваю возможность создания собственного экземпляра readthedocs. Я вижу, что у них есть поддержка Git, Mercurial, Subversion и CVS . У меня, однако, есть пара устаревших проектов, которые представляют собой значительные усилия, чтобы перейти…
12 апр '16 в 05:27
0
ответов
Читать Документы не показывают никаких функций при использовании автомодуля
У меня проблема с визуализацией документации моего проекта в Read the Docs. Все отлично работает локально, выполнив команду make html, но в Read Docs функции, которые должны быть сгенерированы директивом автомодуля, не отображаются. Так устроено мое…
21 сен '18 в 13:26