Use mkdocs for documentation#389
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
@peytondmurray Merge conflicts are gone thanks to Ready to merge once all checks pass |
There was a problem hiding this comment.
Pull Request Overview
This PR sets up documentation using MkDocs and includes a workflow to deploy docs to GitHub Pages. The changes include configuration for MkDocs, reorganization of tutorial notebooks, and setup of documentation dependencies through pip extras.
- Updates setup.py to include documentation dependencies via a "docs" extra
- Adds MkDocs configuration with Material theme and Jupyter notebook support
- Moves tutorial notebooks from g3doc/tutorials to docs/tutorials location
Reviewed Changes
Copilot reviewed 23 out of 36 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| setup.py | Adds docs requirements reading, "docs" extra configuration, and code style updates to double quotes |
| requirements-docs.txt | Defines MkDocs dependencies including material theme and Jupyter support |
| mkdocs.yml | Comprehensive MkDocs configuration with navigation, theming, and plugin setup |
| g3doc/tutorials/*.ipynb | Removes existing tutorial notebooks from their original location |
peytondmurray
left a comment
There was a problem hiding this comment.
Looks good, but can you revert the styling changes in setup.py before merging? Feel free to hit the button once you do. 🚀
e7a76b4 to
8d2e218
Compare
Fixed! Will merge when all checks pass |
This PR sets up documentation using mkdocs and includes a workflow to deploy the docs to GitHub Pages.
Once this PR is merged someone with the appropriate privileges will need to enable publishing docs from the
gh-pagesbranchA preview of the documentation can be found here