Skip to content

Add Read the Docs build config#577

Open
ppolewicz wants to merge 1 commit into
masterfrom
blind_fix_rtd
Open

Add Read the Docs build config#577
ppolewicz wants to merge 1 commit into
masterfrom
blind_fix_rtd

Conversation

@ppolewicz
Copy link
Copy Markdown
Collaborator

Summary

  • add a checked-in Read the Docs config for this repository
  • install the system packages required by the Sphinx docs build on RTD
  • install the Python doc dependency group with uv so RTD builds match local/CI docs builds

Why

The repo currently builds docs in CI, but CD does not publish docs and the repository does not include a .readthedocs.yaml file for RTD to consume. The docs build also requires graphviz and plantuml, which are installed in GitHub Actions but were not declared for RTD.

Verification

  • uv run nox --non-interactive -vs doc

Copy link
Copy Markdown

@jan-sauer-reef jan-sauer-reef left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants