[devel] Q: is python-module-sphinx build-recursion OK?

Igor Vlasenko vlasenko на imath.kiev.ua
Ср Мар 2 01:05:21 MSK 2016


On Tue, Mar 01, 2016 at 04:04:55AM +0300, Ivan Zakharyaschev wrote:
> На самом деле, это из специального автообновляемого пакета
> python3-module-objects.inv и это копируется только в doc/ и tests/, т.е.
> можно предположить, что нужно для тестов (можно легко понять) и ещё для
> чего-то, возможно, документации (не очень понятно, почему документация
> пакета не может быть собрана из своих исходников без зависимости на данные
> из внешнего мира). Я в этом мало что смыслю. Надеюсь на комментарий
> кого-нибудь, кто знает: есть ли причины делать так странно или можно сделать
> по-другому и лучше?

objects.inv -- это база данных, которую sphinx 
использует для создания кросс-ссылок на документацию
других модулей из документации текущего проекта.

К примеру, javadoc тоже может ссылаться в документации
текущего пакета на документацию из других пакетов;
для этого javadoc требует, чтобы соответствующая документация
других пакетов была доступна.

У sphinx другой подход. У него есть централизованная
публичная постоянно обновляемая доступная через интернет
база данных кросс-ссылок.

Когда sphinx генерирует документацию, он смотрит в эту базу
и вставляет там где надо кросс-ссылки.

Раньше sphinx просто автоматом при своей сборке выкачивал
свежий objects.inv из сети.

Когда Дмитрий запретил интернет в hasher chroot,
Евгению пришлось оторвать objects.inv в отдельный 
пакет, а я по его просьбе поручил обновение
этой базы сервису cronbuild.

-- 

I V


Подробная информация о списке рассылки Devel