ansys / ansys/pyedb-core

DOC: use sphinx autoapi instead of autosummary

Open
#355 1 comment 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
7
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### 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

Contributor guide

Open the contributing guide

Research direction

Start with the Sphinx configuration and the current autosummary and numpydoc extensions. Check the status of sphinx-autoapi pull request 399 and whether the PyAnsys fork is required, then run `sphinx-build -M latex` to compare the Enum warnings. Done means the project builds its PDF documentation with autoapi and the reported warnings are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.