Building Reference

Building Zenplate

For convenience, each of these processes is scripted. These scripts can be found in the extras/scripts directory.

Before running the script ensure that the development dependencies are installed. This can be done by running the following command:

# From the root of the repository
pip install -e .[development]

The documentation

The resulting documentation will be located in the extras/docs/site directory.

For POSIX:

./extras/scripts/mkdocs.sh

For Windows:

.\extras\scripts\mkdocs.ps1

The pyinstaller binary

The resulting binary will be located in the dist directory.

For POSIX:

./extras/scripts/pyinstaller.sh

For Windows:

.\extras\scripts\pyinstaller.ps1