Commands

`sphinxpress check`

Loads configuration, prepares the managed environment if enabled, verifies sphinx-build, and runs Sphinx dummy builds.

`sphinxpress list`

Lists configured projects and resolved release metadata.

`sphinxpress build-site`

Builds Jekyll pages and navigation data.

sphinxpress build-site --all
sphinxpress build-site --project tool-a
sphinxpress build-site --projects tool-a,tool-b

`sphinxpress build-epub`

Builds the combined EPUB artifact.

sphinxpress build-epub --all

`sphinxpress build-pdf`

Builds the combined PDF artifact with sphinxpress’s internal WeasyPrint backend by default. It renders the aggregate docs as singlehtml, then converts that HTML to PDF without requiring LaTeX. Install the optional pdf extra or make weasyprint>=67 available in the selected managed build environment. Set [pdf].builder = "latexpdf" to keep using the legacy LaTeX-based path.

sphinxpress build-pdf performs a WeasyPrint preflight before the aggregate singlehtml build. If the configured weasyprint executable is missing, the command fails fast with an actionable message that points to sphinxpress[pdf] and [build.env].packages rather than running a full singlehtml build first. On any singlehtml or WeasyPrint failure, the error message points to the matching log file under [build].log_dir.

sphinxpress build-pdf --all

`sphinxpress build-book`

Format-dispatching wrapper around PDF and EPUB builds.

sphinxpress build-book --format epub --all
sphinxpress build-book --format pdf --all

For --format pdf, the default backend matches build-pdf: aggregate singlehtml plus WeasyPrint, with explicit latexpdf still available through configuration.

`sphinxpress update-release`

Updates one project’s stored release_tag.

sphinxpress update-release --project tool-a --tag v0.1.0

`sphinxpress update-releases`

Resolves and updates release tags for all configured projects.

sphinxpress update-releases --all

`sphinxpress add-project`

Appends a new [[projects]] entry to sphinxpress.toml.

sphinxpress add-project \
  --name tool-a \
  --docs ../tool-a/docs \
  --repo https://github.com/example/tool-a

`sphinxpress validate`

Runs checks, validates generated Jekyll output, and verifies aggregate book project creation.

sphinxpress validate
sphinxpress validate --linkcheck