Pre-release

This release is a pre-release and may not be stable for production use.

hexdoc logo

PyPI - Python Version

hexdoc

A Jinja-based documentation generator for Patchouli books.

This is the library that powers Hex Casting's web book.

IMPORTANT: Version incompatibilities

There are issues related to installing hexdoc with the following dependency versions:

Python 3.12+ on Windows: https://github.com/aio-libs/multidict/issues/887
Node.js 20+: https://github.com/stackgl/headless-gl/issues/268

hexdoc is known to work with Python 3.11 and Node.js 18.

Plugins

See hexdoc-hexcasting-template for instructions to set up a hexdoc plugin for a pre-existing Hex Casting addon.

Contributing

Setup

git submodule update --init

python3.11 -m venv venv

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

pip install -e .[dev]
pre-commit install

Usage

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

GITHUB_SHA=main
GITHUB_REPOSITORY=hexdoc-dev/hexdoc
GITHUB_PAGES_URL=https://hexdoc.hexxy.media

Useful commands:

# show help
hexdoc -h

# serve hexdoc resources locally
# this is useful if serving other books locally that depend on hexdoc resources
nodemon --exec "hexdoc serve --port 8001 --no-merge"

# render and serve the Hex Casting web book in watch mode
nodemon

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

# run tests
pytest  # fast, skips Cookiecutter
nox  # slow, full test suite in an isolated venv
nox --no-install  # after the first Nox run, use this to skip reinstalling everything

# update test snapshots (only running sessions with the tag "test")
nox -t test -- --snapshot-update

# run hexdoc commands in an isolated environment to ensure it works on its own
nox -s hexdoc -- build
nox -s hexdoc -- repl

# set up a dummy book for local testing
nox -s dummy_setup
nox -s dummy_serve

nox -s dummy_hexdoc -- build

nox -s dummy_clean

Badges

Shields.io

Markdown

[![hexdoc](https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc)](https://github.com/hexdoc-dev/hexdoc)

[![powered by hexdoc](https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1)](https://github.com/hexdoc-dev/hexdoc)

HTML

<a href="https://github.com/hexdoc-dev/hexdoc"><img src="https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc" alt="hexdoc" style="max-width:100%;"></a>

<a href="https://github.com/hexdoc-dev/hexdoc"><img src="https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1" alt="powered by hexdoc" style="max-width:100%;"></a>

reStructuredText

.. image:: https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc
    :target: https://github.com/hexdoc-dev/hexdoc
    :alt: hexdoc

.. image:: https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1
    :target: https://github.com/hexdoc-dev/hexdoc
    :alt: powered by hexdoc

Devin's Badges

Thanks to Sam for making these!

HTML

<a target="_blank" href="INSERT_YOUR_BOOK_LINK_HERE"><img src="https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/hexdoc-badgecozy.svg?raw=true" alt="A badge for hexdoc in the style of Devins Badges" width=225></a>

<a target="_blank" href="https://addons.hexxy.media" height=75><img src="https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/addon-badge-cozy.svg?raw=true" alt="A badge for addons.hexxy.media in the style of Devins Badges" width=200></a>

Download files

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

Source Distribution

hexdoc-1!0.1.0a10.tar.gz (129.4 kB view details)

Uploaded Feb 23, 2024 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

hexdoc-1!0.1.0a10-py3-none-any.whl (189.2 kB view details)

Uploaded Feb 23, 2024 Python 3

File details

Details for the file hexdoc-1!0.1.0a10.tar.gz.

File metadata

Download URL: hexdoc-1!0.1.0a10.tar.gz
Upload date: Feb 23, 2024
Size: 129.4 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for hexdoc-1!0.1.0a10.tar.gz
Algorithm	Hash digest
SHA256	`b4b38a42cd9b47537be4449c07d848eab1cf63ae36d07594cec313e6d3b3f763`
MD5	`d0aa4ec9ef8ad2def0f953d90916db51`
BLAKE2b-256	`9b6de62be057290b1972afa131e257d8c5730b6a8754b3f140f79714d10b3489`

See more details on using hashes here.

File details

Details for the file hexdoc-1!0.1.0a10-py3-none-any.whl.

File metadata

Download URL: hexdoc-1!0.1.0a10-py3-none-any.whl
Upload date: Feb 23, 2024
Size: 189.2 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for hexdoc-1!0.1.0a10-py3-none-any.whl
Algorithm	Hash digest
SHA256	`410f36a9eeeb45811cbf59760fc4d6a51ad0794e525426f2564d7c1c73d26b80`
MD5	`cd2ccd75a99545ea1de598532b136bc1`
BLAKE2b-256	`935de7b96b0153e218631b37bafde8bda0723f80384e105d3913f2711142d10d`

See more details on using hashes here.

Release history Release notifications | RSS feed

1!0.1.0a40 pre-release

Jun 14, 2026

1!0.1.0a39 pre-release

Mar 22, 2026

1!0.1.0a38 pre-release

Mar 6, 2026

1!0.1.0a37 pre-release

Feb 15, 2026

1!0.1.0a36 pre-release

Feb 1, 2026

1!0.1.0a35 pre-release

Oct 25, 2025

1!0.1.0a34 pre-release

Oct 20, 2025

1!0.1.0a33 pre-release

Oct 14, 2025

1!0.1.0a32 pre-release

Oct 14, 2025

1!0.1.0a31 pre-release

Oct 11, 2025

1!0.1.0a30 pre-release

Sep 27, 2025

1!0.1.0a29 pre-release

Sep 22, 2025

1!0.1.0a28 pre-release

Sep 10, 2025

1!0.1.0a27 pre-release

Sep 9, 2025

1!0.1.0a26 pre-release

May 12, 2025

1!0.1.0a25 pre-release

Apr 13, 2025

1!0.1.0a24 pre-release

Mar 30, 2025

1!0.1.0a23 pre-release

Feb 24, 2025

1!0.1.0a22 pre-release

Feb 23, 2025

1!0.1.0a21 pre-release

Oct 26, 2024

1!0.1.0a20 pre-release

Sep 8, 2024

1!0.1.0a19 pre-release

Jun 11, 2024

1!0.1.0a18 pre-release

Jun 9, 2024

1!0.1.0a17 pre-release

May 24, 2024

1!0.1.0a16 pre-release

May 4, 2024

1!0.1.0a15 pre-release

May 2, 2024

1!0.1.0a14 pre-release

May 1, 2024

1!0.1.0a13 pre-release

Apr 27, 2024

1!0.1.0a12 pre-release

Apr 7, 2024

1!0.1.0a11 pre-release

Mar 30, 2024

This release

1!0.1.0a10 pre-release

Feb 23, 2024

1!0.1.0a10.dev0 pre-release

Jan 5, 2024

1!0.1.0a9 pre-release

Jan 1, 2024

1!0.1.0a8 pre-release

Dec 30, 2023

1!0.1.0a7 pre-release

Dec 20, 2023

1!0.1.0a6 pre-release

Dec 17, 2023

1!0.1.0a5 pre-release

Dec 17, 2023

1!0.1.0a4 pre-release

Dec 16, 2023

1!0.1.0a3 pre-release

Dec 14, 2023

1!0.1.0a2 pre-release

Dec 10, 2023

1!0.1.0a2.dev0 pre-release

Dec 10, 2023

1!0.1.0a1 pre-release

Dec 4, 2023

1!0.1.0a0 pre-release

Dec 2, 2023

1!0.1.0.dev7 pre-release

Dec 2, 2023

1!0.1.0.dev6 pre-release

Nov 30, 2023

1!0.1.0.dev5 pre-release

Nov 24, 2023

1!0.1.0.dev4 pre-release

Nov 23, 2023

1!0.1.0.dev3 pre-release

Nov 23, 2023

1!0.1.0.dev2 pre-release

Nov 22, 2023

1!0.1.0.dev1 yanked

Nov 21, 2023