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.20.2.1.1.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfcb0a6e99da28fb9b567f1335fe2e9535e076d394ff4f5504c8c3d7b4b09cd3 |
|
MD5 | 038e1b3899fb29e924e59f98021b1f9f |
|
BLAKE2b-256 | a9a0d82de7e31c423e5960edd766c2d74871c789740388c23c81fcc2679c52a6 |
Close
Hashes for hexdoc_minecraft-1.20.2.1.1.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aeb2f07fc8a6b994f17ce44d454d58e0856f233d82c559dff0ee3aadc9dc325b |
|
MD5 | e0a49d9ac952487a1e24d180542aa5e5 |
|
BLAKE2b-256 | fecdcae0a4cc0530925b0d3e9ef42c63134124b7c86df3186366bd55783d6b53 |