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-0.1.3.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7132fef58ee44f47344ed2750655966592848d2fb3d6503935f707664729bf9 |
|
MD5 | 246de51ad12a4850c6d80c86c3146869 |
|
BLAKE2b-256 | 15399d6753c9f9b184dc77a3c5bc9106dada8b1e242b092e29a7dc55d3e4d001 |
Close
Hashes for hexdoc_hexresearch-0.1.3.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b53248cd1019409e69ad2d746ce00272f67e7f383316c51b0d4cc1beb703067c |
|
MD5 | eafaa7a3c31a466c0c7dd030fe5e64c3 |
|
BLAKE2b-256 | f84ec689d6847d641b875e942dbda68e2566a42abdb335968eb9c0c3d1c9dde8 |