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.20.2.1.0.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f5f1d1a3ed88e7d17c6ff6bc98e61df0e400d3cdaa4ddee18f1882d2a1c1988 |
|
MD5 | 706637e17e84349dac5cc745aba42bae |
|
BLAKE2b-256 | 875520a0f7d58e956162a29c96562a9af844194f055dc97c47875c036ae112f6 |
Close
Hashes for hexdoc_minecraft-1.20.2.1.0.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f09e782f365e61be49bc4ce64fedfbf497d433f7070e481af84a551b0f98f369 |
|
MD5 | 9245d0cc3a255c511a84c77df3c99e89 |
|
BLAKE2b-256 | 077e005e3b9e1c456c0e0a521dd0b5b82618149b577d105c0db9264907b5af5c |