Python web book docgen and hexdoc plugin for Minecraft.
Reason this release was yanked:
broken urls
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=object-Object/hexdoc-minecraft
GITHUB_SHA=main
GITHUB_PAGES_URL=https://object-object.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.1.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fd301716382faed5de78c21391902eb5aad09ccf20a1eee498bd947ef5c7fca |
|
MD5 | 8611af910879b56190067ce80ab899fd |
|
BLAKE2b-256 | bd5ad3800e1aff3764a4f1ea285c2f4b7e7d3112f4e535b8b385424f5840af26 |
Close
Hashes for hexdoc_minecraft-1.20.1.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a92952cc971975d99aa83b746d0acdd844bebd81ebc3522e15974ed7a3ac1ad2 |
|
MD5 | 349c0b3675bcb61cbdad27347df78744 |
|
BLAKE2b-256 | f7c16a5a837eac2e85bc7d651384e88488003406cce15c79dec2abfd3b51b1f0 |