Repository navigation
Build the documentation on Read the Docs - #25
Merged
Merged
Conversation
.readthedocs.yaml builds docs/ with Sphinx on Read the Docs, with warnings as errors. A docs workflow does the same build on every push and pull request and keeps the HTML as an artifact. Sphinx is pinned in docs/requirements.txt, which both use. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017otfceeeQ9FrS2sXbyLou2
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017otfceeeQ9FrS2sXbyLou2
ru551n
changed the title
ru551n
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Read the Docs configuration and a docs workflow that builds the documentation in CI.
.readthedocs.yaml: Read the Docs buildsdocs/with Sphinx on Ubuntu 24.04 and Python 3.13, with warnings as errors..github/workflows/docs.yml:-W, on every push and pull request, and uploads the HTML as thedocs-htmlartifact, so a broken cross-reference fails the PR instead of the Read the Docs build,latestthrough the API, with theREADTHEDOCS_TOKENsecret.docs/requirements.txt: pins Sphinx 9.1.0 for both, like ruff is pinned in the lint workflow.The restyled documentation, the VHDL API reference and the release builds were pushed after this PR was merged and continue in #27.
Tests
The docs build with Sphinx 9.1.0 and
-Wwithout warnings locally.🤖 Generated with Claude Code