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

Download files

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

Source Distribution

hexdoc_hexdebug-0.8.1.1.20.1.1.1.tar.gz (89.5 kB view details)

Uploaded Source

Built Distribution

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

hexdoc_hexdebug-0.8.1.1.20.1.1.1-py3-none-any.whl (140.8 kB view details)

Uploaded Python 3

File details

Details for the file hexdoc_hexdebug-0.8.1.1.20.1.1.1.tar.gz.

File metadata

File hashes

Hashes for hexdoc_hexdebug-0.8.1.1.20.1.1.1.tar.gz
Algorithm Hash digest
SHA256 da0e4bb4416f9286e4ea65ec203765f4333c33d7278ac3181575d68c32eb71d1
MD5 a826661aa58100c0acdf5351533dd5f5
BLAKE2b-256 0596e020229752ef3ce92f9c6c4e09c87497485dec8220fd9fabc9ef6ffb2be7

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc_hexdebug-0.8.1.1.20.1.1.1.tar.gz:

Publisher: release.yml on object-Object/HexDebug

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_hexdebug-0.8.1.1.20.1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for hexdoc_hexdebug-0.8.1.1.20.1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 76c15f09874e5ae33b7a05f2eade33ea5b26a23e6ef2961fec37821bc5ecd104
MD5 117b42de3943042750ca5ddb4a74eeb5
BLAKE2b-256 d0615e97566306a98e7844f2f4d4ca461b45ffec380a7b223f4bc2dbc3030992

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc_hexdebug-0.8.1.1.20.1.1.1-py3-none-any.whl:

Publisher: release.yml on object-Object/HexDebug

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.8.1.1.20.1.1.1 This release

2 files

0.1.0.1.0.dev0

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