hexdoc-minecraft

Python web book docgen and hexdoc plugin for Minecraft.

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

python3.11 -m venv venv

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

$env:HATCH_GRADLE_DIR='versions/1.20.2' # Windows
HATCH_GRADLE_DIR='versions/1.20.2'      # everything else
pip install -e .[dev]

Usage

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

GITHUB_REPOSITORY=hexdoc-dev/hexdoc-minecraft
GITHUB_SHA=main
GITHUB_PAGES_URL=https://hexdoc-dev.github.io/hexdoc-minecraft

Useful commands:

# show help
hexdoc -h

hexdoc-minecraft fetch -p versions/1.20.2/hexdoc.toml
hexdoc-minecraft unzip -p versions/1.20.2/hexdoc.toml
hexdoc render -p versions/1.20.2/hexdoc.toml

# start the Python interpreter with some extra local variables
hexdoc repl -p versions/1.20.2/hexdoc.toml

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hexdoc_minecraft-1.21.1.2.0.tar.gz (2.5 MB view details)

Uploaded Aug 15, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

hexdoc_minecraft-1.21.1.2.0-py3-none-any.whl (5.3 MB view details)

Uploaded Aug 15, 2026 Python 3

File details

Details for the file hexdoc_minecraft-1.21.1.2.0.tar.gz.

File metadata

Download URL: hexdoc_minecraft-1.21.1.2.0.tar.gz
Upload date: Aug 15, 2026
Size: 2.5 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for hexdoc_minecraft-1.21.1.2.0.tar.gz
Algorithm	Hash digest
SHA256	`839b8a26f27acd0ee2606518381455e6200287a94b03b7a07827e4b133f5e66d`
MD5	`93093f9a36e0fe94a121819187adc99a`
BLAKE2b-256	`64de36fa6bb3866583cde8a8c5753798f3da4aede73219274653abb0b678b86a`

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc_minecraft-1.21.1.2.0.tar.gz:

Publisher: build_docs.yml on hexdoc-dev/hexdoc-minecraft

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: hexdoc_minecraft-1.21.1.2.0.tar.gz
- Subject digest: 839b8a26f27acd0ee2606518381455e6200287a94b03b7a07827e4b133f5e66d
- Sigstore transparency entry: 2481489308
- Sigstore integration time: Aug 15, 2026
Source repository:
- Permalink: hexdoc-dev/hexdoc-minecraft@5a017eb790a6529b0426cb7d8a73331df5dbf244
- Branch / Tag: refs/heads/main
- Owner: https://github.com/hexdoc-dev
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: build_docs.yml@5a017eb790a6529b0426cb7d8a73331df5dbf244
- Trigger Event: workflow_dispatch