Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: use sphinx autoapi instead of autosummary #355

Open
SMoraisAnsys opened this issue Jan 23, 2024 · 0 comments
Open

DOC: use sphinx autoapi instead of autosummary #355

SMoraisAnsys opened this issue Jan 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@SMoraisAnsys
Copy link
Contributor

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 readthedocs/sphinx-autoapi#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

#354 (comment)

@SMoraisAnsys SMoraisAnsys added the documentation Improvements or additions to documentation label Jan 23, 2024
@SMoraisAnsys SMoraisAnsys changed the title Use sphinx autoapi instead of autosummary DOC: use sphinx autoapi instead of autosummary Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant