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.0.1.20.1.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e4616e57aeba91e9c22fa060bf023231937167843da4d9672aa3e4958cdd385 |
|
MD5 | 46a753352c7ad6c913ac00fd5f36cf77 |
|
BLAKE2b-256 | bc4efb1456ab69251aec661a1777c9af87d31e589a2abd618ef6343332f92d60 |
Close
Hashes for hexdoc_hexdebug-0.1.0.1.20.1.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2251c214d142ece90e58a464a0e7f3061a4acc069fb21539bece6a3bab3677b |
|
MD5 | e3f8c9f319ba574c3ba86b3c6e76d9a8 |
|
BLAKE2b-256 | 0861593ccaf427767cef71d67059c1a590ab7892c921d7b838101988cee0e643 |