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.

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

[Docs] Use mkdocs for documentation #2254

Draft
wants to merge 25 commits into
base: master
Choose a base branch
from

Conversation

smokestacklightnin
Copy link

@smokestacklightnin smokestacklightnin commented Sep 24, 2024

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

TODO:

  • Find a solution for including the C++ API. Currently a C++ handler for mkdocs-material is not implemented and the C handler is paid. A placeholder page has been added.

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