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.1.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2088ae1b36f73d494bd31fb215d0e8682c765deead6bb44fe034cc1c5fcd4fca |
|
MD5 | 6fc20d8cd3d7c11fd41e46e6321f508e |
|
BLAKE2b-256 | 4930b2437b10e0008b27ba71bf434e8ef4f899093afbcde1b70af856306e4dd9 |
Close
Hashes for hexdoc_hexkeys-0.0.1.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40936e9d0659a14f09d719e073d76afab6bea24f22c54f6ce43e2fd4c723bf38 |
|
MD5 | b1350d1756d88e35028f840708752714 |
|
BLAKE2b-256 | 887e71c4a1ecd6f325ae372cf54dc14306157437ca1c3bc5921b01edfd3fdd72 |