Python web book docgen and hexdoc plugin for Oneironaut.
Project description
hexdoc-oneironaut
Python web book docgen and hexdoc plugin for Oneironaut.
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=beholderface/oneironaut
GITHUB_SHA=main
GITHUB_PAGES_URL=https://beholderface.github.io/oneironaut
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
hexdoc_oneironaut-0.2.1.1.0.tar.gz
(210.7 kB
view hashes)
Built Distribution
Close
Hashes for hexdoc_oneironaut-0.2.1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1ff204638733274d34db8be28e7b8be03cea77963a8ce93d66cb7683d9ad29b |
|
MD5 | 052b8a45dbb60c91855e6b6b4f5bf401 |
|
BLAKE2b-256 | 89da3fa51670c99aac6db3139e23f29d4e1685de4d9152841cd7712e34022a07 |
Close
Hashes for hexdoc_oneironaut-0.2.1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cc81ac0b2b80309f8d31abcae69266f724cfcaa53c418023a969a518e44f002 |
|
MD5 | 6309e08f47defe83de77d5a70c598ba7 |
|
BLAKE2b-256 | 7554864fd6b8bccfeaaf8658e669e06322299809eefee55a55dcfc81b147ead2 |