Document adding MkDocs after skipping docs tool#5672
Open
Shizoqua wants to merge 1 commit into
Open
Conversation
Signed-off-by: shizoqua <hr.lanreshittu@yahoo.com>
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
Closes #5603.
This PR documents how to add a MkDocs documentation site to a Kedro project that was created without selecting the
docstool.Development notes
Updated
docs/deploy/package_a_project.mdto fill the previously empty section “Add documentation to a Kedro project if you have not selecteddocstool”.The new section:
docstool scaffold is Sphinx-baseddocs/directorymkdocsandmkdocstrings[python]dependenciesdocs/index.md,docs/api.md, andmkdocs.ymlmkdocstringsVerified with:
uv pip install -e ".[docs]".venv\Scripts\mkdocs.exe build --strictkedro new --tools=none --example=nproject, followed by the documented MkDocs setup andmkdocs buildgit diff --check -- docs/deploy/package_a_project.mdVale and Lychee were not run because they are not installed locally.
Developer Certificate of Origin
Checklist
[RELEASE.md](https://github.com/kedro-org/kedro/blob/main/RELEASE.md)file