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
Built Distribution
Close
Hashes for hexdoc_hexdim-1.1.0.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3a9d1428aca37f2737ee2a3ec81270a2e86fc846277d3402912cca3b8ba79af |
|
MD5 | 410552508361e7769ad6aafff04039d3 |
|
BLAKE2b-256 | 375ca8e30e6667ab6629b24f4cd95dd5f147267ea5dfdccaf488c2c94077f97f |
Close
Hashes for hexdoc_hexdim-1.1.0.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71b1618979df401f9d41d29275d75412c4ab4ca54cfaa26d41838cab9746276b |
|
MD5 | 7b5eb55f9c59c724eea20ba6965318b1 |
|
BLAKE2b-256 | f39e1d4e08348c483c898627ea683decaf52541167d838e6bc970f9b7841e9f2 |