Python web book docgen and hexdoc plugin for Hexbound.
Project description
hexdoc-hexbound
Python web book docgen and hexdoc plugin for Hexbound.
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.
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] --find-links ./doc/libs
Usage
For local testing, create a file called .env
in the repo root following this template:
GITHUB_REPOSITORY=object-Object/hexbound
GITHUB_SHA=1.19
GITHUB_PAGES_URL=https://hexbound.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
File details
Details for the file hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2.tar.gz
.
File metadata
- Download URL: hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2.tar.gz
- Upload date:
- Size: 38.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ae0dd7be39b3ef786ba684c4162797bc04e9ee0c9b6b8ec69a12ef693f79f5f |
|
MD5 | ef859343ebf384d24a1f9e1472623e6f |
|
BLAKE2b-256 | 92e682a503b665df2a0de2e678907c1ea71fbc13e81e18a78dd78e6986da1226 |
File details
Details for the file hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2-py3-none-any.whl
.
File metadata
- Download URL: hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2-py3-none-any.whl
- Upload date:
- Size: 54.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f4a859c431867ed4f479c6cc86c114b21355f08c81c57577eae286dfdd11c73 |
|
MD5 | 0d7d02b1e556b2ad0bc8cf85778f4617 |
|
BLAKE2b-256 | bdb6310a101498524fd85ebef0aec4806b347e96fcd626a42baeebfadbfcf05d |