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.0.1.20.1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab2bc00ce4a718eba68144653f9369f840aee999670bbf45c334d7b062c864d8 |
|
MD5 | 9edaccdeb335baeb15eb2509d9a65426 |
|
BLAKE2b-256 | 6650d855e90c9af5c9e6350c74389a47f582de960e5e71c6a10a9908f799bb7f |
Close
Hashes for hexdoc_hexdebug-0.2.0.1.20.1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc1cb339fcb8ac7e4200ee81bf3b75019accdcc7932e9d6b14bc758cb0cfa390 |
|
MD5 | 3ddf662097e4ba713dc8c99667a6fe39 |
|
BLAKE2b-256 | 594eba822ce8cb0437064af608a564e3412ca9ad336de50b71aee0ec9afd03c9 |