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.19.2.1.1.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f916053b1d3e7cffe51980a203134ec4c891f29a27811199b3927d2e61eeeb7b |
|
MD5 | c564e74d6f25a5a9027b0b8317f57fbd |
|
BLAKE2b-256 | dac9a82b366576846a63ec4da386f724e63661d6589e76829b213e747c565d63 |
Close
Hashes for hexdoc_minecraft-1.19.2.1.1.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7243a0393699bb8cb3f200d4a6f94a532745f462d0062fb1d8c6b7e7a2d5a81 |
|
MD5 | 31fdd10845f89561b5a5ec9635116fb7 |
|
BLAKE2b-256 | e020637eafa6fe545afdb234a3ab8c2984d882c83cb509a998bc9a0bae312e44 |