History

object-Object a607428d1d [Release] Test release		2023-08-31 03:48:03 -04:00
..
src/hexdoc	[Release] Test release	2023-08-31 03:48:03 -04:00
static	Add optional static dir	2023-08-27 19:14:01 -04:00
test	Fix release argument in build	2023-08-31 03:16:25 -04:00
.gitignore	Use actions/deploy-pages	2023-08-27 19:06:20 -04:00
properties.toml	sure let's push a bunch of totally untested code	2023-08-31 03:14:12 -04:00
README.md	Publish via Actions	2023-08-28 01:41:53 -04:00
TODO.md	Fix artifact path for pypi	2023-08-28 03:07:11 -04:00

README.md

doc

Contains the Python docgen for Hex Casting.

Setup

The minimum Python version to run this project is 3.11.

python -m venv venv

.\venv\Scripts\activate  # Windows
source venv/bin/activate # anything other than Windows

# run from the repo root, not doc/
pip install -e .[dev]

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

Usage

hexdoc doc/properties.toml -o out