Make the Read the Docs build work - #28
Merged
Merged
Conversation
The committed .readthedocs.yaml was still the unmodified template: it pointed `sphinx.configuration` at docs/conf.py, which did not exist, so every build failed. Fill it in and add the Sphinx setup it referenced. - docs/conf.py: Sphinx + MyST + Furo, version read from pyproject.toml so it tracks the release bumped by release.yml. - docs/index.md: landing page including the README, with a toctree to ARCHITECTURE. - docs/requirements.txt: doc toolchain only. The docs are prose, so ConfLens itself is never imported at build time and the heavy LLM / NiceGUI dependencies stay out of the build. - sphinxcontrib-mermaid + myst_fence_as_directive, so the ```mermaid fences in ARCHITECTURE.md and the README render as diagrams instead of failing syntax highlighting. - formats: [] — PDF/epub need a headless browser to rasterize mermaid, which the Read the Docs builders do not have. - README: point the LICENSE and .env.example links at the repository. Being relative, they resolved outside the docs tree and 404'd in the rendered site; the absolute URLs work in both places. Known remaining warning: README references docs/overview.png, which has never been committed. That image is already broken on GitHub.
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
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.
The committed .readthedocs.yaml was still the unmodified template: it pointed
sphinx.configurationat docs/conf.py, which did not exist, so every build failed. Fill it in and add the Sphinx setup it referenced.Known remaining warning: README references docs/overview.png, which has never been committed. That image is already broken on GitHub.