Skip to content

[Docs] Use mkdocs for documentation#2254

Open
smokestacklightnin wants to merge 41 commits into
tensorflow:masterfrom
smokestacklightnin:ci/docs/add-mkdocs
Open

[Docs] Use mkdocs for documentation#2254
smokestacklightnin wants to merge 41 commits into
tensorflow:masterfrom
smokestacklightnin:ci/docs/add-mkdocs

Conversation

@smokestacklightnin

@smokestacklightnin smokestacklightnin commented Sep 24, 2024

Copy link
Copy Markdown
Member

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

@peytondmurray peytondmurray left a comment

Copy link
Copy Markdown

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.

Comment thread tensorflow_serving/tools/pip_package/requirements-docs.txt
Comment thread docs/images/tf_full_color_primary_icon.svg Outdated
Comment thread .github/workflows/cd-docs.yml
@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 left a comment

Copy link
Copy Markdown

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
Copy Markdown

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

@smokestacklightnin

smokestacklightnin commented May 20, 2025

Copy link
Copy Markdown
Member Author

@gharibian Is there anything else you need us to do before this PR is merged?

CC: @peytondmurray

@peytondmurray peytondmurray removed the request for review from gharibian July 1, 2025 21:40
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.

4 participants