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.1.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7134e8540551865fd530fd953bddc52d2f17dc4fb05955d45424abd354c8cc0 |
|
MD5 | 8e3c30569d011c226ec7830a51bae659 |
|
BLAKE2b-256 | f4891b9093df868553f418a977f058fe74cc162bfd1d1be4d4d04c03650c3b81 |
Close
Hashes for hexdoc_hexresearch-1.0.1.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1ead510c5350c6be3e2fb8973f205cbffdf6bb7b86af5f8770d8d696b9c2bfd |
|
MD5 | a733ba0b7406e61b43f7bcb80bbbcb4d |
|
BLAKE2b-256 | 35f9f21a569f58cce6e51bb2ee562782c97827f5dcfb37509b211e962975c693 |