History

object-Object f15360e66c Update Pydantic and pin Pyright		2023-08-03 23:10:22 -04:00
..
.vscode	Add workspace definition for qol	2023-07-25 18:16:06 -04:00
src/hexdoc	Update Pydantic and pin Pyright	2023-08-03 23:10:22 -04:00
test	Another refactor, but this time it actually makes sense	2023-07-25 08:42:26 -04:00
properties.toml	Minor refactors and some work on bundling book data	2023-07-27 21:56:10 -04:00
pyproject.toml	Update Pydantic and pin Pyright	2023-08-03 23:10:22 -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