Skip to content

Fix generated Sphinx docs build#5673

Open
Shizoqua wants to merge 1 commit into
kedro-org:mainfrom
Shizoqua:fix/generated-sphinx-docs-build
Open

Fix generated Sphinx docs build#5673
Shizoqua wants to merge 1 commit into
kedro-org:mainfrom
Shizoqua:fix/generated-sphinx-docs-build

Conversation

@Shizoqua

Copy link
Copy Markdown

Description

Fixes #5592 by making docs generated with kedro new --tools=docs build API docs without requiring users to manually discover or run sphinx-apidoc.

Development notes

  • Added generated project docs/Makefile and docs/make.bat.
  • Updated the generated docs html target to run sphinx-apidoc before sphinx-build, which creates docs/source/modules.rst.
  • Kept the existing modules toctree reference in docs/source/index.rst.
  • Updated generated Sphinx conf.py to include the project src path for autodoc imports.
  • Added starter template test coverage and updated the expected docs-tool file count.

Tested with:

  • python -m pytest --no-cov tests/framework/cli/starters -q
    299 passed
  • Generated a project with kedro new --tools docs --example no
  • Ran generated docs/make.bat html
  • Confirmed docs/source/modules.rst and docs/build/html/index.html were created.

Developer Certificate of Origin

All commits are signed off with Signed-off-by.

Checklist

Signed-off-by: shizoqua <hr.lanreshittu@yahoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix the docs tool so generated Sphinx docs build correctly

1 participant