HexCasting/doc
2023-08-27 19:14:01 -04:00
..
src/hexdoc Add optional static dir 2023-08-27 19:14:01 -04:00
static Add optional static dir 2023-08-27 19:14:01 -04:00
test Add hatch-gradle-version and restructure a lot of things 2023-08-27 18:27:19 -04:00
.gitignore Use actions/deploy-pages 2023-08-27 19:06:20 -04:00
properties.toml Add hatch-gradle-version and restructure a lot of things 2023-08-27 18:27:19 -04:00
README.md Switch to editable install 2023-06-27 10:01:18 -04:00
TODO.md Update hatch-gradle-version 2023-08-27 18:51:32 -04:00

doc

Contains the Python docgen for Hex Casting.

Setup

The minimum Python version to run this script is 3.11.

cd doc
python -m venv venv

.\venv\Scripts\activate  # Windows
source venv/bin/activate # anything other than Windows

pip install -r requirements-dev.txt

Usage

python -m hexcasting.scripts.main properties.toml -o out.html