History

object-Object 5124e9770a Make paths relative to properties.toml		2023-08-06 19:44:27 -04:00
..
.vscode	Update docgen to 0.11, mostly	2023-08-06 19:27:52 -04:00
src/hexdoc	Make paths relative to properties.toml	2023-08-06 19:44:27 -04:00
test	Update docgen to 0.11, mostly	2023-08-06 19:27:52 -04:00
properties.toml	Update docgen to 0.11, mostly	2023-08-06 19:27:52 -04:00
pyproject.toml	Update docgen to 0.11, mostly	2023-08-06 19:27:52 -04:00
README.md	Switch to editable install	2023-06-27 10:01:18 -04:00

README.md

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