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.11.1.1.0rc7.dev22.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6eb6eead552be8a33406a4292a05828ac6655282cc0493bff4aaa102e895b75 |
|
MD5 | d1eb5e8d07866066c34edafd57c0472b |
|
BLAKE2b-256 | bdecfab1181fd6750a455d4c55bf7a24395ff5430a579e898408a77e72f4d57f |
Close
Hashes for hexdoc_hexcasting-0.11.1.1.0rc7.dev22-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d64844654ce1c1d326a3fcc335a664cf132d9aa1acb12b863393515433ae15e |
|
MD5 | a3be9ed77b4b9463bf1ac7d19acfa092 |
|
BLAKE2b-256 | 7abb3e6ba7e08b2964a76cb60972a25a30dbc243745b713877262fecc7082398 |