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
# 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.dev24.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5457ffef9d041417fe46739e1e08357c9c179da81b8735381b7cad5a90b6d36a |
|
MD5 | 97b474fe2c978892270c61556907aeb0 |
|
BLAKE2b-256 | 48f60ab91e4568ecde30c097e1c4049f0ab93b5bb873c9ced03fbd3c10d772fc |
Close
Hashes for hexdoc_hexcasting-0.10.3.1.0.dev24-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a27232425caaa5a904851b4577672521372909518306b1a290e054d32005b62 |
|
MD5 | a3320b3e13e86473ce7e1ef9e907de0f |
|
BLAKE2b-256 | e93da6e18a15f03a00dca7fa5791a0f8e3e0625e5fb370a14ba2efa7137e99d9 |