Python web book docgen for Patchouli and Hex Casting.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for object-Object from gravatar.com object-Object

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT License)
  • Author: object-Object, Alwinfy
  • Tags hexdoc
  • Requires: Python >=3.11
  • Provides-Extra: dev , pdoc , test
Classifiers
Report project as malware

Project description

hexdoc logo

Docs - hexdoc.hexxy.media PyPI - Version PyPI - Python Version GitHub Workflow Status (with event) hexdoc

hexdoc

A Jinja-based documentation generator for Patchouli books.

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

Check out the docs at https://hexdoc.hexxy.media!

IMPORTANT: Version incompatibilities

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

hexdoc is known to work with Python 3.11.

Plugins

hexdoc has a few Copier templates that you can use to set up a hexdoc plugin for your mod:

Support

hexdoc does not currently have a dedicated support server. If you have any questions, please feel free to join the Hex Casting Discord server and ask in the #hexdoc channel, or open an issue/discussion on GitHub.

Contributing

Setup

Automatically set up a development environment with Nox:

pipx install nox  # pipx (recommended)
python3 -m pip install nox  # pip

nox -s setup
# next, run the venv activation command printed by uv

Manual 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

# generate and run the full docs website locally, or just run Docusaurus
nox -t docs
nox -s docusaurus

Badges

Shields.io

hexdoc powered by hexdoc

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

A badge for hexdoc in the style of Devins Badges A badge for addons.hexxy.media in the style of Devins 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>

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for object-Object from gravatar.com object-Object

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT License)
  • Author: object-Object, Alwinfy
  • Tags hexdoc
  • Requires: Python >=3.11
  • Provides-Extra: dev , pdoc , test
Classifiers

Release history Release notifications | RSS feed

This version

1!0.1.0a35 pre-release

1!0.1.0a34 pre-release

1!0.1.0a33 pre-release

1!0.1.0a32 pre-release

1!0.1.0a31 pre-release

1!0.1.0a30 pre-release

1!0.1.0a29 pre-release

1!0.1.0a28 pre-release

1!0.1.0a27 pre-release

1!0.1.0a26 pre-release

1!0.1.0a25 pre-release

1!0.1.0a24 pre-release

1!0.1.0a23 pre-release

1!0.1.0a22 pre-release

1!0.1.0a21 pre-release

1!0.1.0a20 pre-release

1!0.1.0a19 pre-release

1!0.1.0a18 pre-release

1!0.1.0a17 pre-release

1!0.1.0a16 pre-release

1!0.1.0a15 pre-release

1!0.1.0a14 pre-release

1!0.1.0a13 pre-release

1!0.1.0a12 pre-release

1!0.1.0a11 pre-release

1!0.1.0a10 pre-release

1!0.1.0a10.dev0 pre-release

1!0.1.0a9 pre-release

1!0.1.0a8 pre-release

1!0.1.0a7 pre-release

1!0.1.0a6 pre-release

1!0.1.0a5 pre-release

1!0.1.0a4 pre-release

1!0.1.0a3 pre-release

1!0.1.0a2 pre-release

1!0.1.0a2.dev0 pre-release

1!0.1.0a1 pre-release

1!0.1.0a0 pre-release

1!0.1.0.dev7 pre-release

1!0.1.0.dev6 pre-release

1!0.1.0.dev5 pre-release

1!0.1.0.dev4 pre-release

1!0.1.0.dev3 pre-release

1!0.1.0.dev2 pre-release

1!0.1.0.dev1 pre-release yanked

Reason this release was yanked:

Extension books are completely broken, use dev2 instead.

1!0.1.0.dev0 pre-release

0.11.1.1.0rc7.dev19 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.11.1.1.0rc7.dev18 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.11.1.1.0rc7.dev17 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.11.1.1.0rc7.dev16 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.11.1.1.0rc7.dev15 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.11.1.1.0rc7.dev14 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.11.1.1.0rc7.dev13 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.11.1.1.0rc7.dev12 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.11.1.1.0rc7.dev11 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.10.3.1.0.dev19 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.10.3.1.0.dev18 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.10.3.1.0.dev17 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.10.3.1.0.dev16 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.10.3.1.0.dev15 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.10.3.1.0.dev14 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.10.3.1.0.dev11 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.9.5.1.0.dev19 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.9.5.1.0.dev18 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.9.5.1.0.dev17 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.9.5.1.0.dev16 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.9.5.1.0.dev15 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.9.5.1.0.dev14 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

0.9.5.1.0.dev11 pre-release yanked

Reason this release was yanked:

Outdated, use hexdoc 1!0.1.x and hexdoc-hexcasting instead.

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.0a35.tar.gz (154.4 kB view details)

Uploaded Source

Built Distribution

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

hexdoc-1!0.1.0a35-py3-none-any.whl (223.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hexdoc-1!0.1.0a35.tar.gz
  • Upload date:
  • Size: 154.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hexdoc-1!0.1.0a35.tar.gz
Algorithm Hash digest
SHA256 dce830ef27653f7aecb71f889256a43b59dc72be08fbfab7d5f9f0091edda0ad
MD5 e9baed1dd0eb4a73fc1cf6615da808d7
BLAKE2b-256 ad9e406aa0c66dab8ccd178173ba0a56da86cb506222b20f3bafcd1b75e2f93c

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc-1!0.1.0a35.tar.gz:

Publisher: ci.yml on hexdoc-dev/hexdoc

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-1!0.1.0a35-py3-none-any.whl.

File metadata

  • Download URL: hexdoc-1!0.1.0a35-py3-none-any.whl
  • Upload date:
  • Size: 223.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hexdoc-1!0.1.0a35-py3-none-any.whl
Algorithm Hash digest
SHA256 149dceb2bcf7215fef6ae20e52b65b984df9a88306a2e2c2cb2572ae644d4e58
MD5 98a0485d8a80c6caa95b1a8228a78be3
BLAKE2b-256 4824e0dbc6ad8210f40eb3ffe0d07afae1f2e0ac7d16c3676d53955843e47877

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc-1!0.1.0a35-py3-none-any.whl:

Publisher: ci.yml on hexdoc-dev/hexdoc

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