ansys / pyedb-core

Ansys Electronics Database Python Client Package
https://edb.core.docs.pyansys.com/
MIT License
2 stars 1 forks source link

DOC: use sphinx autoapi instead of autosummary #355

Open SMoraisAnsys opened 7 months ago

SMoraisAnsys commented 7 months ago

Description of the modifications

Pyansys project are switching from sphinx extension autosummary to autoapi. This should probably wait a bit as we might need some changes associated to https://github.com/readthedocs/sphinx-autoapi/pull/399. Since this PR is taking quiet some time to be merged, the project might be forked by pyansys and we should point to that version in that case.

Note: changing the extensions should solve the issue we are having when building pdf (using sphinx-build -M latex with numpydoc and autosummary). Currently we aren't able to remove the warnings that are triggered on the Enum classes.

Useful links and references

https://github.com/ansys/pyedb-core/pull/354#issuecomment-1904389263