Sphinx, ReadTheDocs и версия пакета

Я поддерживаю пакет, документацию которого я автоматически генерирую с помощью Sphinx на readthedocs.org. Для Sphinx/readthedocs я использую правильно определенные conf.py и .readthedocs.yaml.

Внутри conf.py я использую версию:

import pybliometrics

version = pybliometrics.__version__
release = pybliometrics.__version__.replace("_", "")

Версия генерируется в pybliometrics/__init__.py. Сам пакет также использует свою версию где-то в коде.

Когда я делаю версию с pbr (Разумность сборки Python), например

from pbr.version import VersionInfo

_v = VersionInfo('pybliometrics').semantic_version()
__version__ = _v.release_string()

тогда процесс сборки в readthedocs работает без проблем (при условии, что я заставлю его установить pbr).

Однако, когда это выглядит как

from importlib.metadata import version

__version__ = version("pybliometrics")

то процесс сборки завершается с ошибкой importlib.metadata.PackageNotFoundError: No package metadata was found for pybliometrics. То же самое для importlib_metadata.

Что там происходит? Причина, по которой я переключился на importlib.metadata, заключается в том, что я могу выполнить весь процесс сборки с помощью setuptools_scm и избавиться от setup.py и setup.cfg.

Стоит ли изучать PHP в 2023-2024 годах?
Стоит ли изучать PHP в 2023-2024 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
1
0
60
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Вероятно, вам нужно сделать pip install -e эквивалент в вашем файле сборки RTD requirements.txt.

См. пример .readthedocs.yml здесь и см. требования.txt здесь.

Что там должно быть? В настоящее время мне нужно docs/requirements.txt установить sphinx и два расширения sphinx. Я пытался поставить importlib или importlib_metadata безуспешно.

MERose 03.04.2023 21:40

См. -e . в последней строке примера requirements.txt.

Mikko Ohtamaa 03.04.2023 22:13

Я упустил из виду -e ., и это, кажется, решило мою проблему

MERose 05.04.2023 20:27

Другие вопросы по теме