是否可以使用已安装的包和文件离线阅读 Python GObject Introspection API 文档?

是否可以使用已安装的包和文件离线阅读 Python GObject Introspection API 文档?

在我的 Ubuntu MATE 20.04 LTS 系统上,我看到许多名为女孩1.2...
例如,我想使用gir1.2-gtk-3.0和在 Python 上开发一些新功能gir1.2-caja-2.0
此类包通常只有*.typelib文件,不提供任何 HTML 文档。

我在 DevHelp、Yelp 和 DocHelp 中没有看到他们的文档。

我应该从阅读哪些离线安装的文档开始?

答案1

一般情况下,可以通过访问以下特殊网站进行https://lazka.github.io/pgi-docs/并在这里找到所需的 Python GObject Gir/Typelib 文档。

上述特殊网站是使用特殊pgi-文档公用事业。它在底层使用 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文件夹。可以使用任何 Web 浏览器进行浏览。

相关内容