Python web book docgen and hexdoc plugin for Minecraft.
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for hexdoc_minecraft-1.20.1.1.1.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86655195cdaea975e31bb4f8772be2fbd6defbf52c82ac8c6594899f3210cda8 |
|
MD5 | c64f01707a60896208fea8878e0ce0da |
|
BLAKE2b-256 | 858ccdc3fb69eff2a749f7d0dbafacc7a606739953067efb4b437d53653ad46a |
Close
Hashes for hexdoc_minecraft-1.20.1.1.1.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a64d1c3a537efb2326ae790994ddc7facd7547ca4deb68b21128e9b790bc999d |
|
MD5 | 338b8092017559f7cb0b76728aa92acf |
|
BLAKE2b-256 | 6282ba5382b097f4ff78486999f15ce3718c2429d915c7522134b5cb880344b4 |