History

object-Object d0d3023985 Remove scuffed whitespace stripping		2023-07-19 21:51:43 -04:00
..
src	Remove scuffed whitespace stripping	2023-07-19 21:51:43 -04:00
templates	Remove scuffed whitespace stripping	2023-07-19 21:51:43 -04:00
test	Prefer book.json macros instead of defaults	2023-07-09 19:59:17 -04:00
properties.toml	Jinja, table of contents	2023-07-13 23:14:36 -04:00
pyproject.toml	Fully convert from Dacite to Pydantic!	2023-07-03 21:52:25 -04:00
README.md	Switch to editable install	2023-06-27 10:01:18 -04:00
requirements-dev.txt	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