Metadata-Version: 2.1
Name: hexdoc-minecraft
Version: 1.20.1.1.0.dev1
Summary: Python web book docgen and hexdoc plugin for Minecraft.
Project-URL: Homepage, https://hexdoc-dev.github.io/hexdoc-minecraft
Project-URL: Source, https://github.com/hexdoc-dev/hexdoc-minecraft
Author: object-Object
Keywords: hexdoc
Requires-Python: >=3.11
Requires-Dist: hexdoc~=1!0.1.dev5
Provides-Extra: dev
Requires-Dist: ruff~=0.1.4; extra == 'dev'
Description-Content-Type: text/markdown

# hexdoc-minecraft

Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Minecraft.

## Version scheme

We use [hatch-gradle-version](https://pypi.org/project/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

```sh
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:
```sh
GITHUB_REPOSITORY=hexdoc-dev/hexdoc-minecraft
GITHUB_SHA=main
GITHUB_PAGES_URL=https://hexdoc-dev.github.io/hexdoc-minecraft
```

Useful commands:
```sh
# 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
```
