[DOCS] Sphinx 8: WARNING: document isn't included in any toctree [toc.not_included]
- Dominant language
- Python
- Stars
- 10
- Forks
- 5
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
## Problem
Recent RTD builds started failing out of the blue?
> checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/cratedb-toolkit/checkouts/584/doc/readme.md:
> WARNING: document isn't included in any toctree [toc.not_included]
-- https://app.readthedocs.org/projects/cratedb-toolkit/builds/30692630/#298313868--73
## References
- https://github.com/daq-tools/lorrystream/issues/218
- https://github.com/sphinx-doc/sphinx/issues/14520
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by inspecting doc/readme.md and the documentation toctree configuration, then reproduce the Read the Docs build linked in the issue. Done means the Sphinx 8 build no longer emits toc.not_included for readme.md; check the cited Sphinx and lorrystream issues for expected handling.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100