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.2.1.1.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5820eca91656200a8d0cf15e2607be0ea662c8a328893798d48801be2b7993e0 |
|
MD5 | 8375e9398fb250b1a578038f3821e2a7 |
|
BLAKE2b-256 | 639a0fb6c82f3233ab173585c8ce855a2a8ecbaaebb5cb564e3562c4d60b4358 |
Close
Hashes for hexdoc_minecraft-1.20.2.1.1.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7b5e4746902a9e741d16c185420b47a2f7d930219b6fb4ce133ceb970a31b13 |
|
MD5 | 367c41e75fe32d89369f9bcf3549020c |
|
BLAKE2b-256 | 8eb2a055a54abb2bf35dbeb56a0345b89b4f429a7b706011f575f852b36bc6a6 |