hexdoc-hexthings 0.1.1.1.20.1.1.2

Some extra patterns I think would be neat

hexdoc-hexthings

Python web book docgen and hexdoc plugin for HexThings.

Some extra patterns I think would be neat

Version scheme

We use hatch-gradle-version to generate the version number based on whichever mod version the docgen 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

Install uv, then:

uv sync

.\.venv\Scripts\activate   # Windows
. .venv/bin/activate.fish  # fish
source .venv/bin/activate  # everything else

Usage

For local testing, create a file called .env in the repo root following this template:

GITHUB_REPOSITORY=Real-Septicake/HexThings
GITHUB_SHA=main
GITHUB_PAGES_URL=https://real-septicake.github.io/HexThings

Useful commands:

# update your Python environment and lockfile if you added new dependencies
uv sync

# show help
hexdoc -h

# render and serve the web book in watch mode
nodemon --config doc/nodemon.json

# render and serve the web book
hexdoc serve

# build and merge the web book
hexdoc build
hexdoc merge

# start the Python interpreter with some extra local variables
hexdoc repl