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.2.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f09c7d18e5e2bd122c3d890fbfb3e1c3a8acf8fcf5c82d051f0c2f880b4cf8a3 |
|
MD5 | 5a63710fd05c768ab59d90ac09dee699 |
|
BLAKE2b-256 | 38d29239e2cee29095bc4981e7f3fb6d47d5c61b4476ee1122cd7ff4cfb2775d |
Close
Hashes for hexdoc_hexkeys-0.1.2.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b01366f82eb2d639c1ce3fa30dbd28193f481c45738a9afe3e64fa0ece9f209 |
|
MD5 | c257c0e17241217664efe401be19cc6a |
|
BLAKE2b-256 | 0e93d464e2470a50493a72f2d7eb7b961c06b7ea0e642723498472308a0a5191 |