| Name | hexdoc-minecraft JSON |
| Version |
1.21.0.1.1.dev1
JSON |
| download |
| home_page | None |
| Summary | Python web book docgen and hexdoc plugin for Minecraft. |
| upload_time | 2024-08-26 23:23:25 |
| maintainer | None |
| docs_url | None |
| author | object-Object |
| requires_python | >=3.11 |
| license | None |
| keywords |
hexdoc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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 -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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "hexdoc-minecraft",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "hexdoc",
"author": "object-Object",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/17/ef/1b214329166e3a5222118efa7910691ed5615b38622f79e6cdb1f8cc6225/hexdoc_minecraft-1.21.0.1.1.dev1.tar.gz",
"platform": null,
"description": "# hexdoc-minecraft\n\nPython web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Minecraft.\n\n## Version scheme\n\nWe 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.\n\nThe version is in this format: `mod-version.python-version.mod-pre.python-dev.python-post`\n\nFor example:\n* Mod version: `0.11.1-7`\n* Python package version: `1.0.dev0`\n* Full version: `0.11.1.1.0rc7.dev0`\n\n## Setup\n\n```sh\npython3.11 -m venv venv\n\n.\\venv\\Scripts\\activate # Windows\n. venv/bin/activate.fish # fish\nsource venv/bin/activate # everything else\n\n$env:HATCH_GRADLE_DIR='versions/1.20.2' # Windows\nHATCH_GRADLE_DIR='versions/1.20.2' # everything else\npip install -e .[dev]\n```\n\n## Usage\n\nFor local testing, create a file called `.env` in the repo root following this template:\n```sh\nGITHUB_REPOSITORY=hexdoc-dev/hexdoc-minecraft\nGITHUB_SHA=main\nGITHUB_PAGES_URL=https://hexdoc-dev.github.io/hexdoc-minecraft\n```\n\nUseful commands:\n```sh\n# show help\nhexdoc -h\n\nhexdoc-minecraft fetch -p versions/1.20.2/hexdoc.toml\nhexdoc-minecraft unzip -p versions/1.20.2/hexdoc.toml\nhexdoc render -p versions/1.20.2/hexdoc.toml\n\n# start the Python interpreter with some extra local variables\nhexdoc repl -p versions/1.20.2/hexdoc.toml\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Python web book docgen and hexdoc plugin for Minecraft.",
"version": "1.21.0.1.1.dev1",
"project_urls": {
"Homepage": "https://hexdoc-dev.github.io/hexdoc-minecraft",
"Source": "https://github.com/hexdoc-dev/hexdoc-minecraft"
},
"split_keywords": [
"hexdoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3690eb35469e8932a77b1550f7f18d78f2edcdf5d472acc0b09fb1e3fe061798",
"md5": "00abc6a034e4e42148300fb91e573b50",
"sha256": "84c3322163a13a8dd9f4072139bf2fc1f26b18e3d597311fa0497f72f6a76719"
},
"downloads": -1,
"filename": "hexdoc_minecraft-1.21.0.1.1.dev1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00abc6a034e4e42148300fb91e573b50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 5316773,
"upload_time": "2024-08-26T23:23:23",
"upload_time_iso_8601": "2024-08-26T23:23:23.443820Z",
"url": "https://files.pythonhosted.org/packages/36/90/eb35469e8932a77b1550f7f18d78f2edcdf5d472acc0b09fb1e3fe061798/hexdoc_minecraft-1.21.0.1.1.dev1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17ef1b214329166e3a5222118efa7910691ed5615b38622f79e6cdb1f8cc6225",
"md5": "a7d8d2cf32c3db024169f0ee7ab08cc1",
"sha256": "aac8a782bbdf1c447900ff2c69c31d912ce7378bd923726251464302455839e6"
},
"downloads": -1,
"filename": "hexdoc_minecraft-1.21.0.1.1.dev1.tar.gz",
"has_sig": false,
"md5_digest": "a7d8d2cf32c3db024169f0ee7ab08cc1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 2496780,
"upload_time": "2024-08-26T23:23:25",
"upload_time_iso_8601": "2024-08-26T23:23:25.762138Z",
"url": "https://files.pythonhosted.org/packages/17/ef/1b214329166e3a5222118efa7910691ed5615b38622f79e6cdb1f8cc6225/hexdoc_minecraft-1.21.0.1.1.dev1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 23:23:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hexdoc-dev",
"github_project": "hexdoc-minecraft",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hexdoc-minecraft"
}
