Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 851 Bytes

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 851 Bytes
Raw

Contribute

Overall guidance on contributing to a PyAnsys library appears in the Contributing topic in the PyAnsys developer's guide. Ensure that you are thoroughly familiar with this guide before attempting to contribute to PyPrimeMesh.

The following contribution information is specific to PyPrimeMesh.

Run tests locally

Run tests locally with this command:

    pytest

Note that you must have access to PyPrimeMesh to run the tests. Some of the graphical-related tests must have a previously generated image cache, so you might get errors due to this.

Build documentation

To build PyPrimeMesh documentation, run this command.

In Windows:

    ./doc/make.bat html
    ./doc/make.bat pdf

In Linux:

    make html
    make pdf