My default Sphinx Docs based builder.

Find a file

Johannes Bornhold 5e9a9cd7fb docs: Remove AGENTS.md, covered by README		2026年03月29日 11:17:14 +02:00
.forgejo/workflows	ci: Echo target image tags during push	2026年03月29日 11:04:36 +02:00
docs/decisions	docs: ADR-0001 Include sphinx-markdown-builder	2026年03月27日 14:03:26 +01:00
.gitlab-ci.yml	fix: Create /var/tmp	2025年11月19日 22:35:57 +01:00
action.yml	docs: Update action reference to v0.12.0	2026年03月29日 10:56:43 +02:00
default.nix	feat: Add parameter "system" into default.nix	2025年11月19日 21:10:44 +01:00
flake.lock	feat: Add sphinxcontrib-mermaid for diagram support	2026年01月07日 08:44:11 +01:00
flake.nix	feat: Add blockdiag font support via BLOCKDIAG_FONTPATH	2026年03月18日 09:41:12 +01:00
LICENSE	Add MIT license	2026年02月08日 09:08:20 +01:00
packages.nix	feat: Add sphinx-markdown-builder to Sphinx environment	2026年03月27日 13:59:36 +01:00
README.md	docs: Update README with build instructions and references	2026年03月29日 11:13:35 +02:00
renovate.json	ci: Add renovate configuration	2025年11月21日 15:54:12 +01:00

Sphinx Builder

A container image that bundles Sphinx, common extensions, and build tooling so teams can produce identical documentation builds locally and in CI.

Status - Stable

I am using this for most of my repositories which build Sphinx based documentation.

Use this repository as a Forgejo Action to build Sphinx documentation in CI:

steps:- uses:actions/checkout@v4- uses:johbo/sphinx-builder@v0.12.0

Input	Default	Description
`docs-dir`	`docs`	Directory containing the Sphinx docs (relative to repo root)
`target`	`html`	Sphinx build target (e.g. `html`, `latexpdf`)

Example with non-default values:

- uses:johbo/sphinx-builder@v0.12.0with:docs-dir:documentationtarget:latexpdf

Start a shell with the packages from this repo using nix shell:

nix shell git+https://codeberg.org/johbo/sphinx-builder.git

The container image is built on Codeberg via Forgejo Actions. Trigger a build manually via workflow dispatch in the Actions tab.