Skip to content

Use mkdocs for documentation #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

smokestacklightnin
Copy link
Member

@smokestacklightnin smokestacklightnin commented May 7, 2025

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-pages branch

A preview of the documentation can be found here

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@smokestacklightnin smokestacklightnin marked this pull request as draft May 7, 2025 05:15
@smokestacklightnin
Copy link
Member Author

@peytondmurray Merge conflicts are gone thanks to nbdime.

Ready to merge once all checks pass

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@peytondmurray peytondmurray left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but can you revert the styling changes in setup.py before merging? Feel free to hit the button once you do. 🚀

@smokestacklightnin
Copy link
Member Author

but can you revert the styling changes in setup.py before merging?

Fixed! Will merge when all checks pass

@smokestacklightnin smokestacklightnin merged commit 1266976 into tensorflow:master Jul 25, 2025
6 checks passed
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.

2 participants