Hex Casting web book.
Reason this release was yanked:
Persistent issues with backwards compatibility
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
# export, render, and merge the web book
hexdoc export
hexdoc render
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
Close
Hashes for hexdoc_hexcasting-0.10.3.1.0.dev21.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf19c4685f2c7ec4828948e79f22f0ccf88341eb9b4e199a136cd9e1f4ad53ad |
|
MD5 | 4c2c4e771a728808a2d1a0d9803a5a54 |
|
BLAKE2b-256 | c8443e564d1a34ac7dd889f9075bf0d007f71712c8c330a0acf4cd8c70471126 |
Close
Hashes for hexdoc_hexcasting-0.10.3.1.0.dev21-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c630b753eaafff127f90e120c1321ed1306de91b205fd17f687f41addedcd22 |
|
MD5 | abc9566ea4b03b90330d46a7541531db |
|
BLAKE2b-256 | b2b800e9062c7083011670ebfecb8c7f19714ae24b7877ff1f57513dc778efda |