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.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54990e4dc891277eb01821ff42df5552a0fa9d37c86bb53ad2b25e1dfa187f68 |
|
MD5 | 27037058cb83facc34b98c8d581ac121 |
|
BLAKE2b-256 | e18b35b5417ef41aa357396ab5c008e9c91a6e001d04ef6d538048c08db5e028 |
Close
Hashes for hexdoc_minecraft-1.19.2.1.1.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c3e251390c5c39d9803a7b1d24cee84f38a939b85eaf5070b695a090f3800a5 |
|
MD5 | ffc541b548bbb8fb3559a1e478e91145 |
|
BLAKE2b-256 | d8cae4199fa8f9e954421b760ba670f7854ecdb42274d515edb40406d9bac897 |