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
hexdoc_hexcasting-0.10.3.1.0.tar.gz
(837.7 kB
view details)
Built Distribution
File details
Details for the file hexdoc_hexcasting-0.10.3.1.0.tar.gz
.
File metadata
- Download URL: hexdoc_hexcasting-0.10.3.1.0.tar.gz
- Upload date:
- Size: 837.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1a623e626b9e82dd411d9ffd97631de203c034c4c0471f04a66defac2a421d1 |
|
MD5 | 036e30ffeaa19e5cb2f606f7ebfedfa2 |
|
BLAKE2b-256 | 6c9abced9242837d2214194a20eb87c3274ab92083706ee549a3cd1f62aecab6 |
File details
Details for the file hexdoc_hexcasting-0.10.3.1.0-py3-none-any.whl
.
File metadata
- Download URL: hexdoc_hexcasting-0.10.3.1.0-py3-none-any.whl
- Upload date:
- Size: 1.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3a4909a466c425b8f8265c5b3049f5845ea8b4133f8aa96256aebb124f6b6a5 |
|
MD5 | 5c32960ae634c2021d25f56a06b15445 |
|
BLAKE2b-256 | c5e82de258c7e3e2fb3de3d958f3efc3b902e915a68dfa7c7968e35c5bbda19b |