Skip to content

Document adding MkDocs after skipping docs tool#5672

Open
Shizoqua wants to merge 1 commit into
kedro-org:mainfrom
Shizoqua:doc/add-mkdocs-after-skipping-docs
Open

Document adding MkDocs after skipping docs tool#5672
Shizoqua wants to merge 1 commit into
kedro-org:mainfrom
Shizoqua:doc/add-mkdocs-after-skipping-docs

Conversation

@Shizoqua

Copy link
Copy Markdown

Description

Closes #5603.

This PR documents how to add a MkDocs documentation site to a Kedro project that was created without selecting the docs tool.

Development notes

Updated docs/deploy/package_a_project.md to fill the previously empty section “Add documentation to a Kedro project if you have not selected docs tool”.

The new section:

  • explains that Kedro’s generated docs tool scaffold is Sphinx-based
  • gives MkDocs setup steps for a project without an existing docs/ directory
  • adds mkdocs and mkdocstrings[python] dependencies
  • shows how to create docs/index.md, docs/api.md, and mkdocs.yml
  • includes API documentation from the generated project source with mkdocstrings

Verified with:

  • uv pip install -e ".[docs]"
  • .venv\Scripts\mkdocs.exe build --strict
  • fresh kedro new --tools=none --example=n project, followed by the documented MkDocs setup and mkdocs build
  • git diff --check -- docs/deploy/package_a_project.md

Vale and Lychee were not run because they are not installed locally.

Developer Certificate of Origin

Checklist

Signed-off-by: shizoqua <hr.lanreshittu@yahoo.com>
@Shizoqua
Shizoqua requested a review from AliceCima10 as a code owner July 16, 2026 21:44
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.

Document how to add docs with MkDocs when the docs tool is not selected

1 participant