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
Metadata
Release files for hexdoc-minecraft 1.21.1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hexdoc_minecraft-1.21.1.2.0.tar.gz | 2.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hexdoc_minecraft-1.21.1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.8 MB
Release files / hexdoc_minecraft-1.21.1.2.0.tar.gz
| Download URL | hexdoc_minecraft-1.21.1.2.0.tar.gz |
|---|---|
| Size | 2.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
839b8a26f27acd0ee2606518381455e6200287a94b03b7a07827e4b133f5e66d
|
|
BLAKE2b-256 checksum How to use checksums |
64de36fa6bb3866583cde8a8c5753798f3da4aede73219274653abb0b678b86a
|
| 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 Aug 15, 2026.
Transparency logRelease files / hexdoc_minecraft-1.21.1.2.0-py3-none-any.whl
| Download URL | hexdoc_minecraft-1.21.1.2.0-py3-none-any.whl |
|---|---|
| Size | 5.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6a6d80ab96c44f31166770e549bf44a13b23295b4c1ad1bd7610a28262abb9e3
|
|
BLAKE2b-256 checksum How to use checksums |
fe47ae3597bad0e218b53194fc761baddd1d2c9ff7c72dfec25bd42cbc7ed1b6
|
| 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 Aug 15, 2026.
Transparency log