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
1 maintainer
Metadata
1 maintainer
Release files for hexdoc-oneironaut 0.4.0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hexdoc_oneironaut-0.4.0.1.0.tar.gz | 471.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hexdoc_oneironaut-0.4.0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.0 MB
Release files / hexdoc_oneironaut-0.4.0.1.0.tar.gz
| Download URL | hexdoc_oneironaut-0.4.0.1.0.tar.gz |
|---|---|
| Size | 471.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7d48a51941790f1e73bcaf08e0d0d30f9132f1a814b43c48cd86a0ea4f2dc62b
|
|
BLAKE2b-256 checksum How to use checksums |
ab0f4f67837fa5fd8a2dd8e2fbeeba08322c4bc976f3ace05075c42eda019481
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 6, 2025.
Transparency logRelease files / hexdoc_oneironaut-0.4.0.1.0-py3-none-any.whl
| Download URL | hexdoc_oneironaut-0.4.0.1.0-py3-none-any.whl |
|---|---|
| Size | 576.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f96b07279dce75507128010086317a7430a6e6159db2a90846f10f1c0759d655
|
|
BLAKE2b-256 checksum How to use checksums |
c59ddfa23e004206e7c0d3b0d10520ced86af4ec75375ba0bc925bd97ec026ec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 6, 2025.
Transparency log
