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.18.2.1.1.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 362fdc4ff58a17f9a1b15826f846bc52fe534d7061cf8a728be5d5d4cde5cf47 |
|
MD5 | 8aa363a6ad798090bbe5f15e30fb62e9 |
|
BLAKE2b-256 | 76d7aca6589813615f43b645b8d9afa38e01f5ae1e8d20cdceeb2798c925753d |
Close
Hashes for hexdoc_minecraft-1.18.2.1.1.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d7885594e435db7d4800058b1b8107119509e02f8e7747afe769615becccc7a |
|
MD5 | 5880b4695ed80ed7045c98d37aab6ddf |
|
BLAKE2b-256 | c6ebc1777bd1ca379de51c8280133ce14e288264f0f134fd0aef5ad67c602c88 |