Python web book docgen and hexdoc plugin for Hex Research.
Project description
hexdoc-hexresearch
Python web book docgen and hexdoc plugin for Hex Research.
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=Dashkal/hexresearch
GITHUB_SHA=develop
GITHUB_PAGES_URL=https://dashkal.github.io/hexresearch
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_hexresearch-1.0.0.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc3a39bd9748fcffd985c2d1f7f6dcec0bb89bef2ed77a7d50390334dd26e907 |
|
MD5 | 33f25ef4664d063bfd2f1806a482a3a1 |
|
BLAKE2b-256 | 16b6e4983792c7a1a76bcff53b492dcbd1001db78381483e417e14ce6dd06706 |
Close
Hashes for hexdoc_hexresearch-1.0.0.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39fc15b8f1792827acf531ae56e6aa10b8800bba0279ef8944144503a8b93f76 |
|
MD5 | d78941c4a3d25b0b1b29bf06ee15df89 |
|
BLAKE2b-256 | 077c7202b0538137961cdbb35b9dff314b9792c08ff9c48025b61413bb409879 |