sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.57k stars 2.12k forks source link

Autodoc fails to parse pygobject programs #9123

Open tallero opened 3 years ago

tallero commented 3 years ago

Describe the bug Pygobject programs' custom widgets require gtk resources to be loaded before actual import. I tried importing such resources in the sphinx conf.py, but apparently they are already lost when autodoc try to import the module files.

To Reproduce Try to build an autodoc sphinx documentation for the hello world project linked below.

Expected behavior Documentation generation succeds without issues.

In general I'd like an example configuration for a pygoject project, preferably with autodoc-generated documentation built together with the program when running meson.

Your project https://gitlab.gnome.org/tallero/helloworld

Environment info

tk0miya commented 3 years ago

Could you provide the error messages and logs on the build?

Try to build an autodoc sphinx documentation for the hello world project linked below.

Please let me know how to build this project. I need to know what we should install and what we should do. This is the first time to build a gtk program to me.

tallero commented 3 years ago

I'll integrate the tests I've made on another branch in the hello world later in the day.