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.1.1.1.19.2.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6bfa68f9bb1f490a64705175bc5e65465b89a55798ed638227be1d9ded2d6ca |
|
MD5 | 0ca7ed7b404a01ed343e4f83c23762c4 |
|
BLAKE2b-256 | 939752e3242848f070526eac1834897e6d1e84850d2a8d799c85b5ed8327c522 |
Close
Hashes for hexdoc_hexdebug-0.1.1.1.19.2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30fcc38db14c32c0e4aa14b3fd3ece08f066f688a6689ae685a9a150307141b7 |
|
MD5 | 1b9432bfbff7b7bfeba99c765e1135d2 |
|
BLAKE2b-256 | 93477a1132a607b899a414cf881daf02d123aaf4725ef44bd1e4674bd3694a5e |