Update package layout to PyAnsys guidelines #296
Labels
enhancement
New feature or request
good first issue
Good for newcomers
maintenance
Repository structure maintenance
As with other projects in the PyAnsys ecosystem, the layout of this project should adapt to the general guidelines.
Low effort
Enable Ruff rules
Remove autoapi warning suppression once the codebase is healthier. See Address api documentation generation warning suppressions #1967
Address removed reference labels from module docstrings. See Fix potentially broken references in the documentation #1980
Intermediate effort
Use a
src/
layout. Just need to move the "ansys/" dir inside a "src/" one and fix some links to this new location: Use src/ dir #664Use a
pyproject.toml
and drop anysetup.py
orsetup.cfg
files. Simplify library installation #909Rename
/docs
directory to/doc
: Link issue here.Implement Tox for the project
Use sphinx-autoapi for generating the API reference, see doc: use sphinx-autoapi for API reference #1952
Improve static search live preview performance and fix missing module icons in the api documentation, see Doc: improve static search speed and fix missing module icons #1971
High effort
master
branch tomain
More about packaging guidelines in https://dev.docs.pyansys.com/packaging/structure.html.
The text was updated successfully, but these errors were encountered: