History

object-Object 1768b3759f Build web book from refs/heads/docgen-2-1.20		2023-09-02 21:39:22 +00:00
..
src/hexdoc	Build web book from refs/heads/docgen-2-1.20	2023-09-02 21:39:22 +00:00
static	Add optional static dir	2023-08-27 19:14:01 -04:00
test	Fix merge delete error and some other stuff	2023-08-31 20:49:35 -04:00
properties.toml	Add navbar and auto-fetch Pages url	2023-08-31 23:39:31 -04:00
README.md	Publish via Actions	2023-08-28 01:41:53 -04:00
TODO.md	Properly sort versions, add separator	2023-09-02 13:25:23 -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