Python web book docgen and hexdoc plugin for Hexxy Dimensions.
Project description
hexdoc-hexdim
Python web book docgen and hexdoc plugin for Hexxy Dimensions.
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
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=walksanatora/hexxy-dimensions
GITHUB_SHA=main
GITHUB_PAGES_URL=https://walksanatora.github.io/hexxy-dimensions/
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
hexdoc_hexdim-1.2.1.1.20.0.tar.gz
(13.5 kB
view hashes)
Built Distribution
Close
Hashes for hexdoc_hexdim-1.2.1.1.20.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68795a8aec5e22aa2b2d1f32c2b2e0d08484432e378e552aa80a69656360344d |
|
MD5 | 36c79227479a9b672db4f06588d0545c |
|
BLAKE2b-256 | f3738e92562190b4c0b4c32038a0dcfa9e83c4b11a4a6cf0f79855e7ff0775c1 |
Close
Hashes for hexdoc_hexdim-1.2.1.1.20.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6fdf8e335b573e75b6598d20536efe771be7d4c75e2ab44f3656184de7c6a5e |
|
MD5 | ced6937ab24f172971b57944dad16b85 |
|
BLAKE2b-256 | 502a26dc1bf81b5d6957817eacabb13fe225420e57eb1919a957fd51ec5875ca |