Skip to main content

hexdoc-hexdebug

Python web book docgen and hexdoc plugin for HexDebug.

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 uv, then:

uv sync

.\.venv\Scripts\activate   # Windows
. .venv/bin/activate.fish  # fish
source .venv/bin/activate  # everything else

Usage

For local testing, create a file called .env in the repo root following this template:

GITHUB_REPOSITORY=object-Object/HexDebug
GITHUB_SHA=main
GITHUB_PAGES_URL=https://hexdebug.hexxy.media

Useful commands:

# update your Python environment and lockfile if you added new dependencies
uv sync

# 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

Metadata

Release files for hexdoc-hexdebug 0.9.0.1.20.1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hexdoc-hexdebug 0.9.0.1.20.1.1.0
File Size Uploaded
hexdoc_hexdebug-0.9.0.1.20.1.1.0.tar.gz 89.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hexdoc-hexdebug 0.9.0.1.20.1.1.0
File Interpreter ABI Platform
hexdoc_hexdebug-0.9.0.1.20.1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 231.0 kB

Release files / hexdoc_hexdebug-0.9.0.1.20.1.1.0.tar.gz

Download URL hexdoc_hexdebug-0.9.0.1.20.1.1.0.tar.gz
Size 89.8 kB
Tags Source
SHA-256 checksum
How to use checksums
4f634d53bc4a85206b7d6cde3b7d7525d1dac30b8d57e7877ae610e08ffc3d82
BLAKE2b-256 checksum
How to use checksums
199c1b6937526eada73b4d8fb21d251f20986b08ef3df75fa3672b0b2a44996a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Sep 5, 2026.

Transparency log

Release files / hexdoc_hexdebug-0.9.0.1.20.1.1.0-py3-none-any.whl

Download URL hexdoc_hexdebug-0.9.0.1.20.1.1.0-py3-none-any.whl
Size 141.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
53f35e0722767db12f4e697afc258112f4ead43a034be3eaadc89436b5b2c947
BLAKE2b-256 checksum
How to use checksums
18a6e3d0682a32f4353dae9904a9f312a36285cdfd3776685bf74a76aa8183c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Sep 5, 2026.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page