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.1.1.20.1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 154d1a25aaace3d74a047bad192dad3d5d9426a8fb4e4679ad78df51c147b43d |
|
MD5 | d9e06bc0b7e2872fff02d71b0a57f12d |
|
BLAKE2b-256 | a23853d2b987e67ca5c98f15e3aa808efaec97ee0819c017549c4105d4590404 |
Close
Hashes for hexdoc_hexdebug-0.2.1.1.20.1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61fdccd9768ff697fa85343b7315f6b4f431cc9fa57ceeeb00e836f0bc0ae017 |
|
MD5 | a4e7b41c7cdb5cfe46deed09aea22961 |
|
BLAKE2b-256 | e84cb21b18ed59d1e8c192f2d159942c29a9bcdf821c5cca20400016fada8a5e |