Python web book docgen and hexdoc plugin for Hexcellular.
Project description
hexdoc-hexcellular
Python web book docgen and hexdoc plugin for Hexcellular.
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/hexcellular
GITHUB_SHA=main
GITHUB_PAGES_URL=https://miyucomics.github.io/hexcellular/
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_hexcellular-1.0.1.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 344b9c7159281ec6eeae525243bf15358fc4dab44dd09a72f17a9d83275c23e9 |
|
MD5 | 86d4f51d1a1ae697b71508c62bf31984 |
|
BLAKE2b-256 | eeb32768a9b4e641d628094fdf3d84998229805bde19416c701ab55be0414000 |
Close
Hashes for hexdoc_hexcellular-1.0.1.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9453b57ba519805b3336410fff76cd16fd6e7d1d49521d7a65ba85e24e3ecbe |
|
MD5 | 002409190e3ea800178406301a6f68d1 |
|
BLAKE2b-256 | 89874a28dd05d651676b7651e7b3ba54c5dedb0aa6181a84b55644ad64805a36 |