2023-06-06 14:13:56 +02:00
|
|
|
# doc
|
|
|
|
|
|
|
|
|
|
Contains the Python docgen for Hex Casting.
|
|
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
2023-06-11 01:14:53 +02:00
|
|
|
The minimum Python version to run this script is `3.11`.
|
|
|
|
|
|
2023-06-06 14:13:56 +02:00
|
|
|
```sh
|
|
|
|
|
cd doc
|
|
|
|
|
python -m venv venv
|
|
|
|
|
|
|
|
|
|
.\venv\Scripts\activate # Windows
|
|
|
|
|
source venv/bin/activate # anything other than Windows
|
|
|
|
|
|
2023-06-27 16:01:18 +02:00
|
|
|
pip install -r requirements-dev.txt
|
2023-06-06 14:13:56 +02:00
|
|
|
```
|
2023-06-07 04:41:06 +02:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```sh
|
2023-06-27 16:01:18 +02:00
|
|
|
python -m hexcasting.scripts.main properties.toml -o out.html
|
2023-06-07 04:41:06 +02:00
|
|
|
```
|
