Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.12 KB

README.rst

File metadata and controls

53 lines (33 loc) · 1.12 KB

PyMAPDL Examples

This repository holds examples for PyMAPDL.

Code Style

Code style can be checked by running:

tox -e style

Previous command will run pre-commit for checking code quality.

Documentation

Documentation can be rendered by running:

Windows

tox -e doc-win

MacOS/Linux (requires make)

tox -e doc-linux

The resultant HTML files can be inspected using your favorite web browser:

<browser> .tox/doc_out_html/index.html

Previous command will open the rendered documentation in the desired browser.