Hex Casting web book.
Project description
hexdoc-hexcasting
Python web book docgen and hexdoc plugin for Hex Casting.
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
# run from the repo root, not doc/
pip install -e .[dev]
Usage
For local testing, create a file called .env in the repo root following this template:
GITHUB_REPOSITORY=gamma-delta/HexMod
GITHUB_SHA=main
GITHUB_PAGES_URL=https://gamma-delta.github.io/HexMod
Useful commands:
# show help
hexdoc -h
# render and serve the web book in watch mode
nodemon --config doc/nodemon.json
# render and serve the web book
hexdoc serve
# build and merge the web book
hexdoc build
hexdoc merge
# 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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hexdoc_hexcasting-0.11.3.1.0.tar.gz.
File metadata
- Download URL: hexdoc_hexcasting-0.11.3.1.0.tar.gz
- Upload date:
- Size: 1.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ced6958edb72f3e9666019aa2d1dc0d812ae31db5236e0836ec1bbb42b4a8a0e
|
|
| MD5 |
553ae5c77927078348d315f450244803
|
|
| BLAKE2b-256 |
46e3dbb8f5b089bc924ade14c29b3f182666991ce23bd1d84f11894061ca591e
|
Provenance
The following attestation bundles were made for hexdoc_hexcasting-0.11.3.1.0.tar.gz:
Publisher:
build_docs.yml on FallingColors/HexMod
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hexdoc_hexcasting-0.11.3.1.0.tar.gz -
Subject digest:
ced6958edb72f3e9666019aa2d1dc0d812ae31db5236e0836ec1bbb42b4a8a0e - Sigstore transparency entry: 715896576
- Sigstore integration time:
-
Permalink:
FallingColors/HexMod@eefaf2d411b6360519c9f56fbfe6b0dfba047425 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/FallingColors
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build_docs.yml@eefaf2d411b6360519c9f56fbfe6b0dfba047425 -
Trigger Event:
push
-
Statement type:
File details
Details for the file hexdoc_hexcasting-0.11.3.1.0-py3-none-any.whl.
File metadata
- Download URL: hexdoc_hexcasting-0.11.3.1.0-py3-none-any.whl
- Upload date:
- Size: 1.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1cca00f1699fdf2e7b6b0440120fbbcb960125a158161a94cdd8b1c3746b34a3
|
|
| MD5 |
ab128ec992aa9c009880b683c2b8dd75
|
|
| BLAKE2b-256 |
79e50b963c186741a55e4d92053e5a7a4e8c70d4a2c03911f8b2affd38811f76
|
Provenance
The following attestation bundles were made for hexdoc_hexcasting-0.11.3.1.0-py3-none-any.whl:
Publisher:
build_docs.yml on FallingColors/HexMod
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hexdoc_hexcasting-0.11.3.1.0-py3-none-any.whl -
Subject digest:
1cca00f1699fdf2e7b6b0440120fbbcb960125a158161a94cdd8b1c3746b34a3 - Sigstore transparency entry: 715896579
- Sigstore integration time:
-
Permalink:
FallingColors/HexMod@eefaf2d411b6360519c9f56fbfe6b0dfba047425 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/FallingColors
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build_docs.yml@eefaf2d411b6360519c9f56fbfe6b0dfba047425 -
Trigger Event:
push
-
Statement type:
