Fix generated Sphinx docs build#5673
Open
Shizoqua wants to merge 1 commit into
Open
Conversation
Signed-off-by: shizoqua <hr.lanreshittu@yahoo.com>
Shizoqua
requested review from
AliceCima10,
ElenaKhaustova and
merelcht
as code owners
July 16, 2026 21:55
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.
Description
Fixes #5592 by making docs generated with
kedro new --tools=docsbuild API docs without requiring users to manually discover or runsphinx-apidoc.Development notes
docs/Makefileanddocs/make.bat.htmltarget to runsphinx-apidocbeforesphinx-build, which createsdocs/source/modules.rst.modulestoctree reference indocs/source/index.rst.conf.pyto include the projectsrcpath for autodoc imports.Tested with:
python -m pytest --no-cov tests/framework/cli/starters -q299 passedkedro new --tools docs --example nodocs/make.bat htmldocs/source/modules.rstanddocs/build/html/index.htmlwere created.Developer Certificate of Origin
All commits are signed off with
Signed-off-by.Checklist
[RELEASE.md](https://github.com/kedro-org/kedro/blob/main/RELEASE.md)file