ansys / pymechanical-stubs

Project to generate Mechanical API stubs
https://scripting.mechanical.docs.pyansys.com/
MIT License
2 stars 0 forks source link

Mechanical stubs to sphinx documentation #1

Closed klmcadams closed 1 year ago

klmcadams commented 1 year ago

Created mechanical API documentation from the mechanical stubs generated by main.py.

Added package directory containing doc and doc/source folders to create sphinx documentation from docstrings. Adjusted main.py to create source code docstrings directory in "package/src/Ansys" instead of "out/Ansys" Added fix_str function to gen.py to remove `1 from docstrings Added encoding to init.py scripts that are created in gen.py Added pre-commit checks to the repository.

doc - contains Makefile, make.bat, and source folder. Run "make html" in this directory to create sphinx documentation from package/src/Ansys doc/source - contains conf.py, autoapi template and index.rst files for creation of sphinx documentation from package/src/Ansys