You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I currently work on a project that includes CPP module binded with pybind11. This means in addition to the classical .py modules, there will be .so modules generated by pybind.
On previous Sphinx versions, the autosummary plugin did not complain about the format of .so modules, but Sphinx 5.0 now fails because of it (see the stack trace below):
robin-cls@px-2019:~/dev/sphinx5_autosummary_fail/doc$ sphinx-build . ../buildSphinx v5.0.0 en cours d'exécution
création du dossier de destinataire... fait
[autosummary] engendrement d’un auto-sommaire pour : index.rst
Extension error (sphinx.ext.autosummary):
Le gestionnaire <function process_generate_options at 0x7f842948b670> de l'évènement 'builder-inited' a créé une exception. (exception: source is not a .py file: '/home/robin-cls/dev/sphinx5_autosummary_fail/doc/example.cpython-39-x86_64-linux-gnu.so')
I expected a run that properly generates the autosummary for the binded CPP module. Sphinx 4.5 runs without errors and generate HTML documentation for the binded module
Sphinx v4.5.0 en cours d'exécution
[autosummary] engendrement d’un auto-sommaire pour : index.rst
[autosummary] engendrement d’un auto-sommaire pour : /home/robin-cls/dev/sphinx5_autosummary_fail/doc/example.rst, /home/robin-cls/dev/sphinx5_autosummary_fail/doc/test.rst
Construction en cours [mo] : cibles périmées pour les fichiers po 0
Construction [html] : cibles périmées pour les fichiers sources 1
Mise à jour de l'environnement : [nouvelle configuration] 3 ajouté(s), 0 modifié(s), 0 supprimé(s)
Lecture des sources... [100%] test
Recherche des fichiers périmés... aucun résultat
Environnement de sérialisation... fait
Vérification de la cohérence... fait
Document en préparation... fait
Écriture... [100%] test
Génération des index... genindex py-modindex fait
écriture des pages additionnelles... search fait
copie des fichiers statiques... fait
Copie des fichiers complémentaires... fait
Export de l'index de recherche dans English (code: en)... fait
Export de l'inventaire des objets... fait
La compilation a réussi.
Les pages HTML sont dans ../build.
Describe the bug
I currently work on a project that includes CPP module binded with pybind11. This means in addition to the classical .py modules, there will be .so modules generated by pybind.
On previous Sphinx versions, the autosummary plugin did not complain about the format of .so modules, but Sphinx 5.0 now fails because of it (see the stack trace below):
How to Reproduce
I reduced my problem to a simple reproductible case here : https://github.com/robin-cls/sphinx5_autosummary_fail (see the README.MD for generating the binded module and the documentation).
Expected behavior
I expected a run that properly generates the autosummary for the binded CPP module. Sphinx 4.5 runs without errors and generate HTML documentation for the binded module
Your project
https://github.com/robin-cls/sphinx5_autosummary_fail
Screenshots
OS
Linux
Python version
3.9
Sphinx version
5.0
Sphinx extensions
sphinx.ext.autosummary
Extra tools
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: