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.20.1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36ba9610892f1c7125776649b93ab4a80b3c3aec0e5313c5305904e0b949e10a |
|
MD5 | 2ea260e0f138f39652ec725cdfdaec55 |
|
BLAKE2b-256 | a6dc59cae7af16041f974ea8a746e60556ccc108c7f38fabc900534d311336f5 |
Close
Hashes for hexdoc_hexdebug-0.1.1.1.20.1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | af10fd21609e0d799753655e3f8f4d33a921c58c6803e328fecf3492aa91f233 |
|
MD5 | e33fabb07f51f335f5ce90f03ff323e4 |
|
BLAKE2b-256 | 1c68747de9e0b70d9784034c7492dc67441d317699ca48257a79ec83f242793c |