Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Build docs with mkdocs #6901

Merged
merged 33 commits into from
Sep 4, 2024
Merged

Build docs with mkdocs #6901

merged 33 commits into from
Sep 4, 2024
+1,870 −1,180

Conversation

smokestacklightnin
Copy link
Contributor

@smokestacklightnin smokestacklightnin commented Aug 13, 2024 •
edited by peytondmurray
Loading

This PR builds docs using mkdocs

Remaining tasks

  • Add pages not in markdown format
  • Fix broken links. Links are broken mostly because they are not currently in mkdocs format, or because they point to resources or pages not in the repository
  • Add images -- Many images were actually already present
  • Add theming using CSS (Thanks @peytondmurray)
  • The proto submodule is not showing up in the docs because mkdocstrings reads docstrings without executing code, but docstrings are only added at run time. We currently show the members of the module and will include their documentation in a subsequent PR

@keerthanakadiri keerthanakadiri self-assigned this Aug 14, 2024
@smokestacklightnin smokestacklightnin force-pushed the ci/docs/try-mkdocs branch 2 times, most recently from f68b65c to 03c59c2 Compare August 22, 2024 04:46
@review-notebook-app Review Notebook App
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@smokestacklightnin smokestacklightnin force-pushed the ci/docs/try-mkdocs branch 2 times, most recently from b7434b3 to 1512cff Compare August 26, 2024 05:35
@smokestacklightnin smokestacklightnin marked this pull request as ready for review August 28, 2024 00:00
@smokestacklightnin
Copy link
Contributor Author

@lego0901 All tests are currently passing and the PR is officially ready for review and merge

@smokestacklightnin
Copy link
Contributor Author

@lego0901 All checks pass and the PR is ready for review and merge

lego0901
lego0901 approved these changes Aug 29, 2024
View reviewed changes
Copy link
Member

@lego0901 lego0901 left a comment

Choose a reason for hiding this comment

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

Thanks!

@smokestacklightnin
Fix linting errors
a6103fd
@peytondmurray
Fix tests
e732085 
- Remove black as docs dependency
- Revert inadvertent scikit-learn version number change
- Remove doc dependencies from `all` optional target
- Fix tfx.v1.proto.__init__ to correctly import the protobufs
- For ci-test.yml, install in normal mode (not editable)
@peytondmurray
Copy link
Contributor

Had to skip a flaky test to get this to pass; merging now, though.

@peytondmurray peytondmurray merged commit 9236d49 into tensorflow:master Sep 4, 2024
14 checks passed
@peytondmurray peytondmurray mentioned this pull request Sep 6, 2024
Closed
5 tasks
@smokestacklightnin smokestacklightnin mentioned this pull request Sep 10, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lego0901 lego0901 lego0901 approved these changes

Assignees

@keerthanakadiri keerthanakadiri

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@smokestacklightnin @peytondmurray @lego0901 @keerthanakadiri