Skip to main content

hexdoc-hexautomata

Python web book docgen and hexdoc plugin for HexAutomata.

Provides items with ability listening to various game events and triggering custom spells.

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=YukkuriC/HexAutomata
GITHUB_SHA=main
GITHUB_PAGES_URL=https://yukkuric.github.io/HexAutomata

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

Metadata

Release files for hexdoc-hexautomata 0.3.5.1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hexdoc-hexautomata 0.3.5.1.1.1
File Size Uploaded
hexdoc_hexautomata-0.3.5.1.1.1.tar.gz 539.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hexdoc-hexautomata 0.3.5.1.1.1
File Interpreter ABI Platform
hexdoc_hexautomata-0.3.5.1.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 1.1 MB

Release files / hexdoc_hexautomata-0.3.5.1.1.1.tar.gz

Download URL hexdoc_hexautomata-0.3.5.1.1.1.tar.gz
Size 539.7 kB
Tags Source
SHA-256 checksum
How to use checksums
cec0eb3cfac73ba06c75aecdf46ac88474132301572bb1b819435b7210fbc13e
BLAKE2b-256 checksum
How to use checksums
c03015510f7cd589abb061f5765900337901de664b1a56e7edafb71b533556c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 6, 2026.

Transparency log

Release files / hexdoc_hexautomata-0.3.5.1.1.1-py3-none-any.whl

Download URL hexdoc_hexautomata-0.3.5.1.1.1-py3-none-any.whl
Size 582.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4cfe61a520693c7eaaa75268b6240c07ff80ef55ef2afcc4b2b6b6f584da7955
BLAKE2b-256 checksum
How to use checksums
affcbddd87465dd2ae4a1e94026264c66298309a6b7fca2b9d2242d66e00d4be
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 6, 2026.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page