Python web book docgen and hexdoc plugin for HexDebug.
Reason this release was yanked:
old version scheme, outdated
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.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45291df2f9b404aa6110f7cb6d2d3a89273e0d4c0e4cf16f3226994d2f26d71d |
|
MD5 | e5eaa023db93ab27d78c2ff72fbb4846 |
|
BLAKE2b-256 | c3501ca6e70307248c02558ec4d768614f02322619422e8b9d113b3867a1c849 |
Close
Hashes for hexdoc_hexdebug-0.1.0.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc8237c149e77af25add3b9667f0c938a133fdc63e5c6ac3dd0547d9018dada1 |
|
MD5 | 81773a26fb628c9e97d4f94fd6fa2640 |
|
BLAKE2b-256 | b690c3fcfa7c5321b914d5c53771efc0f108abe6569c44b02501453eb92c4566 |