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

[Docs] Use mkdocs for documentation #2254

Open
wants to merge 38 commits into
base: master
Choose a base branch
from
Open

[Docs] Use mkdocs for documentation #2254

wants to merge 38 commits into from

Conversation

smokestacklightnin
Copy link

@smokestacklightnin smokestacklightnin commented Sep 24, 2024 •
edited
Loading

Google Would like to migrate the documentation for serving away from their internal systems, so this PR implements that migration.

Changes in this PR:

  • Add mkdocs to the dependencies and add a configuration for it
  • Add a GitHub workflow to deploy the documentation on GitHub Pages
  • Fixed admonitions
  • Add white background to rendered png images so they are legible in dark mode
  • Move tensorflow_serving/g3doc/ -> docs/, the standard location for documentation
  • Build C++ API docs with Doxygen

Here is a preview

@smokestacklightnin smokestacklightnin mentioned this pull request Sep 24, 2024
Open
peytondmurray
peytondmurray requested changes Oct 16, 2024
View reviewed changes
Copy link

@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.

Small requested changes - otherwise this looks good.

tensorflow_serving/tools/pip_package/requirements-docs.txt Show resolved Hide resolved
docs/images/tf_full_color_primary_icon.svg Outdated Show resolved Hide resolved
.github/workflows/cd-docs.yml Show resolved Hide resolved
@smokestacklightnin smokestacklightnin marked this pull request as ready for review October 16, 2024 20:51
@rtg0795 rtg0795 requested a review from gharibian October 16, 2024 22:45
@peytondmurray peytondmurray removed their assignment Oct 17, 2024
@peytondmurray peytondmurray self-requested a review October 22, 2024 21:18
peytondmurray
peytondmurray approved these changes Oct 22, 2024
View reviewed changes
Copy link

@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 now - thank you!

@peytondmurray
Copy link

@gharibian Is there anything I can do to help push this through? It would be really nice to get this merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@peytondmurray peytondmurray peytondmurray approved these changes

@gharibian gharibian Awaiting requested review from gharibian

Assignees

@smokestacklightnin smokestacklightnin

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@smokestacklightnin @peytondmurray