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.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d220a12bd3e569ce577d412c09cee9d989afd504243b191c77154c6c9e796f6c |
|
MD5 | 63fe62ac327b6f65ebf3b9aa77a0c62c |
|
BLAKE2b-256 | 09aac83b6dc45e0ce629e4cbac6fdee4cc4b0d275246ee201ffb4bb5b8dfadf2 |
Close
Hashes for hexdoc_hexdebug-0.1.0.1.20.1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1becabbc13a58be0dced070dad35d90366da7b925e6043df6c193d37dfe3e815 |
|
MD5 | f9aff6a79e6269c05a3004875076a95b |
|
BLAKE2b-256 | 306084e7ff1145ff627d366bc40ef2a7a68a33ef1b773ba88ac1bd3a6fba9478 |