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.1.1.0.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbcec07bcd5391345b7542057bbe5443d7acd4481bb559e623354cc860ba53c6 |
|
MD5 | a0e8a9aeedbadea08e5b3158e22ea660 |
|
BLAKE2b-256 | b4e47d1738d8fef93d53ea6c1c46954f8079c44a7c64311bf97e2c16bda457aa |
Close
Hashes for hexdoc_minecraft-1.20.1.1.0.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5bf87f5b4f736dddb96531568b8596b550fa29c8da503f2e6a872967241aaf7 |
|
MD5 | 31fd8e9e796428b9879d1dcd9b9ef2b8 |
|
BLAKE2b-256 | 9e92ddbc0a7ad0248d44412c344c15c6365a54b92b4ae1d567a86e560749fc17 |