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.18.2.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8448041b9058ef2fd505b04df6ca7651f1094e4edc60150071dfa0a325509ca |
|
MD5 | 24005e8f4abc4fab2dbf2e7a65012d32 |
|
BLAKE2b-256 | 7ddd25b9dbd523193fda1313628d56f784230ab987baf06cfd5de8cce46a3714 |
Close
Hashes for hexdoc_minecraft-1.18.2.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84a032178fef6f1e17ee0c47700d4e7c958714736fe126f08ba82ae6ce6e38a0 |
|
MD5 | 6262e3bd9258b85254d9b01bc986c8e1 |
|
BLAKE2b-256 | 4d6d6e01b6de88ca76c0c6eb25544c422d960982803bcbd2a2b785a8ebbb597f |