fix(docs): make MkDocs strict build use docs dir#376
Open
carloshvp wants to merge 1 commit into
Open
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
mkdocs.ymlto usedocs_dir: docsinstead of the repository rootllms.txtinputs, and edit links to be relative todocs/Why
docs_dir: .causes current MkDocs strict builds to fail before page rendering because the docs directory is the parent of the config file. This removes the repo-root docs source workaround and makes a plain strict build valid.mkdocs.ymlwas also normalized from CRLF to LF in this PR. That keepsgit diff --checkclean and avoids the sed/line-ending fragility that affected generated docs configs.Fixes #364.
Validation
Result: strict docs build passes locally.