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.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2d74c27f94a484dbfff666f1365a30ccf19e02a2c1a279a03bcc81963f379dd |
|
MD5 | c864b65c95fbdec1acaab9fedb8d1d9a |
|
BLAKE2b-256 | f9384ce7fc59d8c7932e059bac1f36306be8813caff336424e5f52d9fd267c61 |
Close
Hashes for hexdoc_minecraft-1.18.2.1.1.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4b2a436da7b2389f1281393c0dffd8faf5bb328bd669fc18b93da591864922d |
|
MD5 | 42f42e5d6016c3c54b90e62ea3c2262a |
|
BLAKE2b-256 | 50954fe51c521ddf7247aab1e6f254c223de1f93bd2aff4fb2b7759b187d1071 |