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
hexdoc export
# start the Python interpreter with some extra local variables
hexdoc repl
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.19.2.1.0.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9dc85edfb2a4ee59b766b143f9606d9f94c99e4caf36024ccd155cd1cf4341d |
|
MD5 | ec044e41e0dcb55fc51bc7228a8699c5 |
|
BLAKE2b-256 | 1c90f6aea22e40cae81fd29b4713f128757af60a3b252ebedc3c6a099091fe70 |
Close
Hashes for hexdoc_minecraft-1.19.2.1.0.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4fceb63b5c36d5782846d5fd42a84612724dec667db032d16e0e9e7550c9069e |
|
MD5 | cd5526abb1798657a6e56ed7e045628e |
|
BLAKE2b-256 | 04bc7fe6a688960fc5779dbdb0cbaa34c2e8210de8162e8254aa77490ba854df |