docs: fix toctree and broken doc reference warnings#1305
Merged
niccokunzmann merged 1 commit intocollective:mainfrom Mar 29, 2026
Merged
docs: fix toctree and broken doc reference warnings#1305niccokunzmann merged 1 commit intocollective:mainfrom
niccokunzmann merged 1 commit intocollective:mainfrom
Conversation
- Add explanation/ directory to the main toctree in index.rst, resolving the 'document isn't included in any toctree' warning for explanation/index.rst (introduced in PR collective#1281) - Fix broken :doc:`component-api` reference in CHANGES.rst to point to the correct path :doc:`../explanation/api-design`, resolving the 'unknown document' warning The documentation build now completes with zero warnings under -W (warnings as errors) mode. Contributes to collective#1158
Documentation build overview
Show files changed (7 files in total): 📝 7 modified | ➕ 0 added | ➖ 0 deleted
|
niccokunzmann
approved these changes
Mar 29, 2026
Member
|
Thanks. Since we do not have warningsansd these warnings indicate serious problems with the docs, do you suggest that the CI should fail in case of warnings? It seems to me, that would be a feature. |
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
2 participants
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.
Summary
Fix the two remaining Sphinx build warnings that cause
-W(warnings as errors) mode to fail.Changes
1. Add
explanation/to main toctree (docs/index.rst)The
explanation/directory was added in PR #1281 but was not included in any toctree, causing:Added an
Explanationsection to the mainindex.rsttoctree.2. Fix broken
:doc:reference inCHANGES.rstLine 54 referenced
:doc:\component-api`which doesn't exist. The correct path is:doc:`../explanation/api-design`(relative todocs/reference/whereCHANGES.rstis included viachangelog.rst`).Verification
Documentation build now completes with zero warnings under
-Wmode:Contributes to #1158
📚 Documentation preview 📚: https://icalendar--1305.org.readthedocs.build/