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.18.2.1.0.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c125353fffc572ab81a44a1ff5981e352fccf7fef1e4be67ad938bc160ca477 |
|
MD5 | 4a45bec86c3883fb18f378e2d9ab8a8b |
|
BLAKE2b-256 | 70c1cdb85dcede0aca182f1e136c52f1345d722319ff76c2e359aa671484d4db |
Close
Hashes for hexdoc_minecraft-1.18.2.1.0.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f4e4a23984e302e4a4f9b66b6ff14c8495e48a452aceaf3db71a16037770bf5 |
|
MD5 | 831117a5093b54f61dc77ebf1ba41b65 |
|
BLAKE2b-256 | 6d133674232e1c465a946741eadd38781503c5e756b13d2b0b2e0e43630f7613 |