History

object-Object e05c9ebeb9 Resolve some TODOs and minor refactoring		2023-08-23 08:42:32 -04:00
..
.vscode	Update docgen to 0.11, mostly	2023-08-06 19:27:52 -04:00
src/hexdoc	Resolve some TODOs and minor refactoring	2023-08-23 08:42:32 -04:00
test	Resolve some TODOs and minor refactoring	2023-08-23 08:42:32 -04:00
properties.toml	Minor properties rearrange	2023-08-22 23:58:03 -04:00
pyproject.toml	Add ModResourceLoader, un-generic HexDocModel, class-based context	2023-08-20 22:37:07 -04:00
README.md	Switch to editable install	2023-06-27 10:01:18 -04:00
TODO.md	Resolve some TODOs and minor refactoring	2023-08-23 08:42:32 -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