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

Как я могу использовать сюжетную директиву matplotlib с python-3 в ReadTheDocs?
У меня есть проект python-3 , в котором используется plot-directive для создания и встраивания диаграмм matplotlib на лету, и я использую ReadTheDocs для автоматического создания документации проекта. Директива plot действительно работает...
857 просмотров
schedule 26.09.2023

Readthedocs высмеивает, что не работает с Matplolitb
Read the Docs не будет создавать документы для моего пакета, поскольку он включает в себя matplotlib. Я использовал код на их веб-сайте , чтобы сымитировать matplotlib, но по-прежнему сборка не удалась, потому что для сборки matplotlib требуются...
93 просмотров
schedule 07.01.2023

Как переопределить шаблон в readthedocs?
Недавно я добавил документацию sphinx для blowdrycss в readthedocs. Я хочу переопределить шаблон layout.html в readthedocs . Мое текущее переопределение шаблона отлично работает на localhost , но не на readthedocs. В проекте используется тема...
1432 просмотров

Вставьте интерактивное изображение SVG в документацию Sphinx
У меня есть файл изображения SVG с несколькими узлами, каждый из которых связан с URL-адресом. Если я открою этот файл прямо в браузере, я могу щелкнуть каждый узел, и он откроет разные URL-адреса. Однако, когда я использую это изображение в своей...
7212 просмотров

прочитать сборку документации не удалось UnicodeDecodeError
Я нахожусь на https://readthedocs.org , я пытаюсь создать свой проектный документ, написанный на python3. настройки: тип документации: Sphinx html язык программирования: питон использовать виртуальную среду интерпретатор Python:...
186 просмотров
schedule 02.12.2023

В сборке темы Read The Docs со Sphinx, как удалить лишнее пространство после включения изображения
Я использую Sphinx с темой Read The Docs для создания веб-сайта. Я включаю изображения справа от текста: .. figure:: fig/image.png :width: 150px :align: right Lorem ipsum ... Результат, полученный после компиляции: Мой вопрос: как...
259 просмотров

Не удалось клонировать частные репозитории github на локальном сервере readthedocs
Я установил локальный сервер readthedocs , но не могу построить частные репозитории github из моей организации через django-allauth . У меня есть права администратора во всех репозиториях, и я настроил django-allauth в панели администратора:...
1107 просмотров
schedule 18.03.2023

Макет зависимости зависимости
Представьте себе следующий сценарий: у вас есть пакет Python с именем «foo», который зависит от «bar». Сам пакет 'bar' зависит от другого пакета Python, скажем, shapely, который зависит от библиотеки C, которая не может быть установлен на...
151 просмотров
schedule 18.03.2023

Структура папок ReadTheDocs Theme с использованием Sphinx
Я хочу создать цифровую версию своих конспектов лекций. Я установил sphinx и изменил файл config.py таким образом, чтобы тема ReadTheDocs работала. Я хочу иметь аналогичную структуру, как на следующем снимке экрана (из Прочтите документацию по...
171 просмотров
schedule 03.06.2023

Как правильно настроить импорт PyQt5 на readthedocs?
Создание документации sphinx для проекта , импортирующего PyQt5, завершается ошибкой ( журнал сборки ) с QStandardPaths: XDG_RUNTIME_DIR not set, defaulting to '/tmp/runtime-docs' qt.qpa.screen: QXcbConnection: Could not connect to display Could...
772 просмотров
schedule 15.06.2022

Почему моя сборка Read the Docs не работает?
Я пытаюсь сделать документацию с прочтением документации для фиктивного пакета, чтобы узнать, как использовать RTD. Я выполнил это руководство и успешно сделал index.html и отправил свои изменения в git (хотя я использую gitlab вместо github для...
61 просмотров
schedule 15.02.2022

Python MagicMock слишком много издевается при использовании декоратора
Я пытаюсь получить документацию для установки ReadTheDocs через Sphinx. Классы, которые я документирую, наследуются от более крупного Framework, который я не могу легко установить и поэтому хотел бы поиздеваться над ним. Тем не менее, Mock кажется...
88 просмотров

Несогласованная навигация по разделу Sphinx (тема RTD)
Мою проблему сложно передать словами. Я постараюсь изо всех сил. Используя Sphinx 2.0.0, у меня есть проект со следующим «корневым» toctree. Это индексное дерево маркеров: Welcome to FIRST Robotics Documentation...
389 просмотров

Сбой сборки Read-the-docs с невозможностью импорта имени «PackageFinder» из «pip._internal.index»
Сборка документов Sphinx в read-the-docs завершается со следующей ошибкой (полный журнал ниже): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index'...
5073 просмотров
schedule 20.03.2023

Неправильный рендеринг блоков кода по readthedocs + mkdocs
У меня проблема с отрисовкой блоков кода в проекте документации с использованием Mkdocs с темой readthedocs. Кажется, что блоки кода неправильно анализируют новые строки, поэтому весь код в блоке кода отображается как одна строка. Репо можно...
197 просмотров

Тема sphinx rtd выделяет определенные слова в блоках кода
Возможно ли в Sphinx RTD выделять определенные слова в блоках кода? Я знаю, что есть emphasize-lines , но я хотел бы выделить не всю строку, а только отдельные части кода.
94 просмотров
schedule 18.01.2023

Использование GitLab + Прочтите документацию по частной виртуальной машине: сбой сборки RTD
Фон Я технический писатель, пытаюсь использовать Read the Docs для создания документации для одного из наших продуктов. Поскольку у нас есть соглашение о неразглашении любой публикации, я должен разместить документацию на виртуальной машине, чтобы...
575 просмотров