History

object-Object c9f4941bad Improve model naming		2023-08-25 00:32:10 -04:00
..
.vscode	Use black extension	2023-08-23 21:50:55 -04:00
src/hexdoc	Improve model naming	2023-08-25 00:32:10 -04:00
test	Mildly scuffed lazy link resolution to handle addon links	2023-08-23 21:47:07 -04:00
.gitignore	Addon fixes	2023-08-24 00:30:22 -04:00
properties.toml	Addon fixes	2023-08-24 00:30:22 -04:00
pyproject.toml	Improve model naming	2023-08-25 00:32:10 -04:00
README.md	Switch to editable install	2023-06-27 10:01:18 -04:00
TODO.md	Improve model naming	2023-08-25 00:32:10 -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