Skip to main content

hexdoc-caduceus

Python web book docgen and hexdoc plugin for Caduceus.

A Clojure-based Hex Casting addon for advanced meta-evaluation. Created for HexJam 2025.

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.

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=object-Object/Caduceus
GITHUB_SHA=main
GITHUB_PAGES_URL=https://github.com/object-Object/Caduceus

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

# build and merge the web book
hexdoc build
hexdoc merge

# start the Python interpreter with some extra local variables
hexdoc repl

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hexdoc_caduceus-0.3.0.1.20.1.1.0.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hexdoc_caduceus-0.3.0.1.20.1.1.0-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file hexdoc_caduceus-0.3.0.1.20.1.1.0.tar.gz.

File metadata

File hashes

Hashes for hexdoc_caduceus-0.3.0.1.20.1.1.0.tar.gz
Algorithm Hash digest
SHA256 c1e4917859719f4a2adacfe43f7852f597c9e9b072398a092895a67d4f34a593
MD5 0bf90b0552f7a718241d5fd597c3e6b1
BLAKE2b-256 a614f4c6876c4774892ec208cfaabb606c0082ab08d5bc9e233cd75071d3e9c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc_caduceus-0.3.0.1.20.1.1.0.tar.gz:

Publisher: release.yml on object-Object/Caduceus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hexdoc_caduceus-0.3.0.1.20.1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hexdoc_caduceus-0.3.0.1.20.1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 13293c5009fe01e2d5a52fb30c2f7d936bc2dbfa6cb2a4eb8f46807524d5430b
MD5 385c145428f12a8c3f40621ae5758106
BLAKE2b-256 187e82585888e9c62985250bfdf7067a7e5bf8d75c7a13ab7dd1425345087f21

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc_caduceus-0.3.0.1.20.1.1.0-py3-none-any.whl:

Publisher: release.yml on object-Object/Caduceus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.0.1.20.1.1.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page