Package: hexdoc
hexdocAJinja-based documentation generator forPatchoulibooks.This is the library that powersHex Casting's web book.IMPORTANT: Version incompatibilitiesThere are issues related to installing hexdoc with the following dependency versions:Python 3.12+ on Windows:https://github.com/aio-libs/multidict/issues/887Node.js 20+:https://github.com/stackgl/headless-gl/issues/268hexdoc is known to work with Python 3.11 and Node.js 18.PluginsSeehexdoc-hexcasting-templatefor instructions to set up a hexdoc plugin for a pre-existing Hex Casting addon.ContributingSetupgitsubmoduleupdate--init

python3.11-mvenvvenv

.\venv\Scripts\activate# Windows.venv/bin/activate.fish# fishsourcevenv/bin/activate# everything elsepipinstall-e.[dev]pre-commitinstallUsageFor local testing, create a file called.envin the repo root following this template:GITHUB_SHA=mainGITHUB_REPOSITORY=hexdoc-dev/hexdocGITHUB_PAGES_URL=https://hexdoc.hexxy.mediaUseful commands:# show helphexdoc-h# serve hexdoc resources locally# this is useful if serving other books locally that depend on hexdoc resourcesnodemon--exec"hexdoc serve --port 8001 --no-merge"# render and serve the Hex Casting web book in watch modenodemon# start the Python interpreter with some extra local variableshexdocrepl# run testspytest# fast, skips Cookiecutternox# slow, full test suite in an isolated venvnox--no-install# after the first Nox run, use this to skip reinstalling everything# update test snapshots (only running sessions with the tag "test")nox-ttest----snapshot-update# run hexdoc commands in an isolated environment to ensure it works on its ownnox-shexdoc--build
nox-shexdoc--repl# set up a dummy book for local testingnox-sdummy_setup
nox-sdummy_serve

nox-sdummy_hexdoc--build

nox-sdummy_cleanBadgesShields.ioMarkdown[![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<ahref="https://github.com/hexdoc-dev/hexdoc"><imgsrc="https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc"alt="hexdoc"style="max-width:100%;"></a><ahref="https://github.com/hexdoc-dev/hexdoc"><imgsrc="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 hexdocDevin's BadgesThanks toSamfor making these!HTML<atarget="_blank"href="INSERT_YOUR_BOOK_LINK_HERE"><imgsrc="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><atarget="_blank"href="https://addons.hexxy.media"height=75><imgsrc="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>