Skip to main content

hexdoc plugin for HexIntent web book docs.

Project description

hexdoc-hexintent

Python web book docgen and hexdoc plugin for HexIntent. Current release version: 2.1.3.

Setup (Windows)

py -3.11 -m venv .venv
.\.venv\Scripts\activate
pip install -e .[dev]

Local usage

Create a file named .env in the repo root:

GITHUB_REPOSITORY=withgallantry/HexIntent
GITHUB_SHA=main
GITHUB_PAGES_URL=https://withgallantry.github.io/HexIntent

Run docs commands from the repo root:

hexdoc -h
hexdoc build
hexdoc merge
hexdoc serve

Publish to PyPI

The Python package published from this repo is hexdoc-hexintent.

Use the Build the web book GitHub Actions workflow with:

  • release = true
  • publish = PyPI

The workflow publishes via GitHub OIDC trusted publishing, so the repository must be configured as a trusted publisher for the hexdoc-hexintent project on PyPI.

Watch mode:

npx nodemon --config doc/nodemon.json

Notes

  • doc/hexdoc.toml points at src/main/resources, so your existing Patchouli data is used directly.
  • If your GitHub repo slug differs, update .env values accordingly.

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_hexintent-2.1.7.1.0.0.tar.gz (7.2 MB view details)

Uploaded Source

Built Distribution

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

hexdoc_hexintent-2.1.7.1.0.0-py3-none-any.whl (7.6 MB view details)

Uploaded Python 3

File details

Details for the file hexdoc_hexintent-2.1.7.1.0.0.tar.gz.

File metadata

  • Download URL: hexdoc_hexintent-2.1.7.1.0.0.tar.gz
  • Upload date:
  • Size: 7.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hexdoc_hexintent-2.1.7.1.0.0.tar.gz
Algorithm Hash digest
SHA256 e5f7e175ccedab029a8cd29fe1c73e4f4a0b30c1f5c0d26d7db383124c25977a
MD5 e589d01057152df969269817c7e5c0cf
BLAKE2b-256 42a70671d1745bff4d7ff177649ce2b6fe21f6e388add6665bf587171af4ec71

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc_hexintent-2.1.7.1.0.0.tar.gz:

Publisher: build_docs.yml on withgallantry/HexIntent

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_hexintent-2.1.7.1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hexdoc_hexintent-2.1.7.1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 18631482f237c4dc5130f8bfad9cbf77eae849d324afc47f7613ca4169bb03ab
MD5 97f4ef5c3d809452925848a93581fd02
BLAKE2b-256 43cefbb4cb91d528576edd4907777573d98f8854b669f2b9844868641e3ec5ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc_hexintent-2.1.7.1.0.0-py3-none-any.whl:

Publisher: build_docs.yml on withgallantry/HexIntent

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

Supported by

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