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.1.3.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38106e0f577ad82e88bc171de37d507e0fc86399ffaef29ac8057fff5a7cca8b |
|
MD5 | 6bee9b8f90df3d20556e4d681a060a32 |
|
BLAKE2b-256 | 7b082901f04bda0087ac33bee4cc119138725d5e24885dd67edf23851db20f61 |
Close
Hashes for hexdoc_hexkeys-0.1.3.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ce1088a76a6dc5fcea607481fea9ac97afc54bb4c226e9009bdbaef52f1c7c7 |
|
MD5 | a15cd7173cba9731326c6c3540ae8c3b |
|
BLAKE2b-256 | d13586c8dc72c215647f14d04244afe7aab344457dddc0e1ec44cc3a92cf960c |