Python web book docgen and hexdoc plugin for Hexical.
Project description
hexdoc-hexical
Python web book docgen and hexdoc plugin for Hexical.
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=miyucomics/hexical
GITHUB_SHA=main
GITHUB_PAGES_URL=https://miyucomics.github.io/hexical/
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_hexical-1.3.0.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 767213675bec1ecb7bad1d25bfecb24271afd6d4c3545f62523759b4859c5e67 |
|
MD5 | b497665d9e425d0e0dbeed684a43eda2 |
|
BLAKE2b-256 | fd80e9d49573a3c85a610308fbb9201bf6c6046da54a5d9fa0e6ec59cb0d4c65 |
Close
Hashes for hexdoc_hexical-1.3.0.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1842cc5fd023a0c5ef1c9ce7e3e46fa3c6815926ed3ca25b23f3e9fda6d4931b |
|
MD5 | 48df05542d7d796e262e0e317b6ee8e8 |
|
BLAKE2b-256 | 53d6f2919c3cb7abc0f1288acd66f3a0d560becd03bf2beab4afd57a75901c55 |