Python web book docgen and hexdoc plugin for Hex Keys.
Project description
hexdoc-hexkeys
Python web book docgen and hexdoc plugin for Hex Keys.
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
Install Python 3.11 and Node 18 (20+ is not currently supported).
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=MoonlitJolteon/hex-keys-addon
GITHUB_SHA=main
GITHUB_PAGES_URL=https://moonlitjolteon.github.io/hex-keys-addon
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_hexkeys-0.0.2.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | de9d16d78462a4d56e8d0c2ba48efdd2f5a257acbc3eb4e219d20a565a3013d0 |
|
MD5 | 475968d5d9f5a464f93469d70640c81f |
|
BLAKE2b-256 | 7cc2f6b1c00d6f5e120f907886a3a0379015de15d3999394d02928b0492047aa |
Close
Hashes for hexdoc_hexkeys-0.0.2.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b90daa0cdaa67208433d9216f6ee69c4257887586369214dac3a4dd1220ec675 |
|
MD5 | f934654aec00dac0307d72ffbc3b69cd |
|
BLAKE2b-256 | fea231cf350b346575a4c1d38b4129074a2b700d6666a7dedbb41b368d703510 |