Python web book docgen and hexdoc plugin for HexDebug.
Project description
hexdoc-hexdebug
Python web book docgen and hexdoc plugin for HexDebug.
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=object-Object/HexDebug
GITHUB_SHA=main
GITHUB_PAGES_URL=https://hexdebug.hexxy.media
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_hexdebug-0.2.2.1.20.1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | db035e7af69cb1d2ead65d92a0beb7252826458fffbb26490e747d5c1b559f78 |
|
MD5 | 7100be52e26d5032d9ed9f196f12ec81 |
|
BLAKE2b-256 | e01ec8837cce625656f1015ff6aa58b07631c6f81d75e98ae506dc6f08ecb6a6 |
Close
Hashes for hexdoc_hexdebug-0.2.2.1.20.1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ccf70eecfb892d603d037a5b70c473c483b402edee48e7e3eb4511c44486f7a |
|
MD5 | 54cd11e94c276460327f461f65bc33fe |
|
BLAKE2b-256 | c16e88f236319d68c58fe6e7d4cca438bc435cde10f8202c731920f25ddf3b35 |