Quickstart
Create a sphinxpress.toml file in the repository that will publish the docs.
[site]
root = "site"
base_url = "https://docs.example.com"
tools_dir = "tools"
nav_data_dir = "_data/tool_nav"
layout = "tool-doc"
title = "Example Docs"
[build]
work_dir = ".sphinxpress"
sphinx_build = "sphinx-build"
fail_on_warning = true
keep_build_dir = false
parallel = "auto"
[book]
title = "Example Documentation"
author = "Example Team"
language = "en"
version = "0.1.0"
copyright = "2026, Example Team"
project_order = ["tool-a"]
[pdf]
builder = "weasyprint"
output = "dist/example-documentation.pdf"
[epub]
builder = "epub"
output = "dist/example-documentation.epub"
[release]
tag_prefix = "v"
release_url_template = "{repo_url}/releases/tag/{tag}"
[[projects]]
name = "tool-a"
title = "Tool A"
docs_root = "../tool-a/docs"
conf_dir = "../tool-a/docs"
root_doc = "index"
repo_url = "https://github.com/example/tool-a"
release_strategy = "manual"
release_tag = "v0.1.0"
Validate the configuration:
sphinxpress check
Build the Jekyll pages:
sphinxpress build-site --all
Build book outputs:
sphinxpress build-epub --all
sphinxpress build-pdf --all
The default PDF path uses sphinxpress’s internal WeasyPrint backend, so LaTeX
is not required unless you explicitly set [pdf].builder = "latexpdf".