History

object-Object 6c43f01d86 Build web book from refs/heads/docgen-2-1.20		2023-09-05 05:42:55 +00:00
..
src/hexdoc	Build web book from refs/heads/docgen-2-1.20	2023-09-05 05:42:55 +00:00
static	Add optional static dir	2023-08-27 19:14:01 -04:00
test	Remove snapshots and improve some documentation	2023-09-02 17:56:43 -04:00
properties.toml	Add navbar and auto-fetch Pages url	2023-08-31 23:39:31 -04:00
README.md	Remove snapshots and improve some documentation	2023-09-02 17:56:43 -04:00
TODO.md	Remove snapshots and improve some documentation	2023-09-02 17:56:43 -04:00

README.md

doc

Contains the Python docgen for Hex Casting.

Version scheme

This package uses hatch-gradle-version to generate a version number based on the mod version it was built with.

The version is in this format: mod-version.python-version.mod-pre.python-dev.python-post

For example:

Mod version: 0.11.1-7
Python package version: 1.0.dev0
Full version: 0.11.1.1.0rc7.dev0

Setup

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