docs: mkdocs GitHub Pages deploy - #3
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an automated MkDocs-based documentation deployment to GitHub Pages and updates documentation configuration/links to match the new docs site location.
Changes:
- Replace Sphinx tooling with MkDocs Material + mkdocstrings in project extras.
- Update MkDocs config/nav and fix a couple of internal docs links.
- Add a GitHub Actions workflow to build and deploy docs to GitHub Pages.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| pyproject.toml | Swaps docs dependencies to MkDocs stack and updates the published documentation URL. |
| mkdocs.yml | Adjusts site/repo URLs and expands nav to include all user guide pages. |
| docs/user-guide/ml-readiness.md | Fixes internal links to point at the correct pages under MkDocs. |
| .github/workflows/docs.yml | Adds CI workflow to build MkDocs site and deploy via GitHub Pages actions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
docs.yml) — builds on push to main, deploys viaactions/deploy-pagesmkdocs.ymlto include all 8 user guide pages (was missing 5)pyproject.tomlml-readiness.mdsite/to.gitignoreTest plan
mkdocs build --strictpasses locallyNote: GitHub Pages needs to be enabled in repo settings (Settings > Pages > Source: GitHub Actions) before the deploy will work.