Можно ли читать документацию Python GObject Introspection API в автономном режиме, используя уже установленные пакеты и файлы?

В моей системе Ubuntu MATE 20.04 LTS я вижу много пакеты с именем gir1.2 ... .
Например, я хочу разработать некоторые новые функции на Python, используя gir1.2-gtk-3.0 и gir1.2-caja-2.0 .
Такие пакеты обычно содержат только файлы *. Typelib и не предоставляют никакой документации в формате HTML.

Я не вижу их документации в DevHelp, Yelp и DocHelp.

С чтения какой офлайн-установленной документации мне следует начать?

0
задан 1 May 2021 в 14:31

1 ответ

В общем, это возможно, посетив специальный сайт по адресу https://lazka.github.io/pgi-docs/ и найдя необходимый Python GObject Gir / Документы Typelib здесь.

Указанный выше специальный сайт создан с помощью специальной утилиты pgi-docgen . Он использует Docker под капотом.
Я создаю этот проект, чтобы упростить процесс создания локальной документации.

Для создания локальной документации

  • для Ubuntu 20.04 LTS и новее (на основе Debian Bullseye) -

     git clone https://github.com/N0rbert/pgi-docgen
    cd pgi-docgen 
     ./ docker-build.sh 
     
  • для Ubuntu 18.04 LTS (на основе Debian Buster) -

     git clone https://github.com/N0rbert/pgi-docgen - b debian-buster 
    cd pgi-docgen 
     ./ docker-build.sh 
     

Локальная документация будет собрана в папке _docs / _build . Возможно, просматривали с помощью любого веб-браузера.

0
ответ дан 7 May 2021 в 17:41

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

Похожие вопросы: