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
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.2.1.0.tar.gz
(210.7 kB
view hashes)
Built Distribution
Close
Hashes for hexdoc_oneironaut-0.2.2.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99d6dc07c22d358e96d0f3b1c9c416246506dc6585f77c9e0433db799f874b9b |
|
MD5 | a5ff6b61b82da8c62053d34219361545 |
|
BLAKE2b-256 | 303523519a0c09a9ab7d4563c607bc9325807099066ec0846cdf4119c5c5f726 |
Close
Hashes for hexdoc_oneironaut-0.2.2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e64303f92043f1cdc0fab1993864f79a145bab1e2e9cf41a745044688175ea1d |
|
MD5 | c5fc953ed27593930f5481c3cb657b9c |
|
BLAKE2b-256 | f2261fd15617d091f0a6a98254eebe268f006763b2c35e0d2364582d55487b96 |