2023-06-06 14:13:56 +02:00
|
|
|
# doc
|
|
|
|
|
|
|
|
|
|
Contains the Python docgen for Hex Casting.
|
|
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
2023-08-28 07:41:53 +02:00
|
|
|
The minimum Python version to run this project is `3.11`.
|
2023-06-11 01:14:53 +02:00
|
|
|
|
2023-06-06 14:13:56 +02:00
|
|
|
```sh
|
|
|
|
|
python -m venv venv
|
|
|
|
|
|
|
|
|
|
.\venv\Scripts\activate # Windows
|
|
|
|
|
source venv/bin/activate # anything other than Windows
|
|
|
|
|
|
2023-08-28 07:41:53 +02:00
|
|
|
# run from the repo root, not doc/
|
|
|
|
|
pip install -e .[dev]
|
2023-06-06 14:13:56 +02:00
|
|
|
```
|
2023-06-07 04:41:06 +02:00
|
|
|
|
2023-08-28 07:41:53 +02:00
|
|
|
### CI/CD
|
|
|
|
|
|
|
|
|
|
- Under Settings > Environments, create a new environment called `pypi`
|
|
|
|
|
- Follow these instructions: https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/
|
|
|
|
|
- TODO
|
|
|
|
|
|
2023-06-07 04:41:06 +02:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```sh
|
2023-08-28 07:41:53 +02:00
|
|
|
hexdoc doc/properties.toml -o out
|
2023-06-07 04:41:06 +02:00
|
|
|
```
|
