-
Notifications
You must be signed in to change notification settings - Fork 2.2k
[Docs] Use mkdocs
for documentation
#2254
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
Open
smokestacklightnin
wants to merge
38
commits into
tensorflow:master
Choose a base branch
from
smokestacklightnin:ci/docs/add-mkdocs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
38 commits
Select commit
Hold shift + click to select a range
d313040
Get basic documentation up and running
smokestacklightnin 40e2829
Add basic documentation deployment workflow
smokestacklightnin bb78fe4
Add cache dependency path
smokestacklightnin 5a8148d
Add empty index page
smokestacklightnin 7012295
Fix internal links
smokestacklightnin 407e1b5
Fix broken links
smokestacklightnin 9efc0c2
Fix bash command listing
smokestacklightnin 9689343
Fix virbatim text
smokestacklightnin 8330c42
Fix broken link
smokestacklightnin b857e67
Fix broken link
smokestacklightnin bf4b58f
Fix broken links
smokestacklightnin c78f143
Add REST api docs
smokestacklightnin d9ee576
Add gRPC api docs
smokestacklightnin c794ab1
Reorganize guide and tutorial files and fix links
smokestacklightnin 3af20e0
Add tutorials to docs
smokestacklightnin d3399f5
Fix admonitions
smokestacklightnin 660d28d
Fix broken links
smokestacklightnin 163c8f4
Move landing page to `index.md`
smokestacklightnin 01951b3
Add white background to images
smokestacklightnin 00e32b8
Add placeholder for C++ docs
smokestacklightnin 81c9dce
Remove logo
smokestacklightnin 65e463e
Change workflow triggers from debugging to production settings
smokestacklightnin 0b70681
Add link to C++ api docs placeholder
smokestacklightnin f2dbc9d
Add build docs check on pull request
smokestacklightnin 36e085f
Move docs to standard location; fix links
peytondmurray a04efb5
Bump Python version
smokestacklightnin ebbb44a
Move docs requirements to common location
smokestacklightnin d5ba899
Only trigger on push to `master`
smokestacklightnin 3517b90
Build docs with Doxygen
smokestacklightnin f3d1c27
Install Doxygen in deploy GH action
smokestacklightnin 7c1f2b4
Install `graphviz` to generate Doxygen diagrams
smokestacklightnin c45275d
Install doxygen with apt
smokestacklightnin eda9623
Fix link on homepage
smokestacklightnin 42b45af
Remove commented import
smokestacklightnin 1963415
Simplify url
smokestacklightnin f62049a
Add a splash page for the cpp docs; clean up hook; add gitignore
peytondmurray b14d621
Remove unused icon
smokestacklightnin caf3b72
Point to landing page
smokestacklightnin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: deploy-docs | ||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: | ||
- 'master' | ||
pull_request: | ||
permissions: | ||
contents: write | ||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Python 3.12 | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: '3.12' | ||
cache: 'pip' | ||
cache-dependency-path: | | ||
tensorflow_serving/tools/pip_package/setup.py | ||
|
||
- name: Save time for cache for mkdocs | ||
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | ||
|
||
- name: Caching | ||
uses: actions/cache@v4 | ||
with: | ||
key: mkdocs-material-${{ env.cache_id }} | ||
path: .cache | ||
restore-keys: | | ||
mkdocs-material- | ||
|
||
- name: Install Dependencies | ||
run: | | ||
sudo apt install -y doxygen graphviz | ||
pip install -r tensorflow_serving/tools/pip_package/requirements-docs.txt | ||
|
||
- name: Deploy to GitHub Pages | ||
run: | | ||
git config user.name github-actions[bot] | ||
git config user.email 41898282+github-actions[bot]@users.noreply.github.com | ||
mkdocs gh-deploy --force | ||
if: (github.event_name != 'pull_request') | ||
|
||
- name: Build docs to check for errors | ||
run: | | ||
mkdocs build | ||
if: (github.event_name == 'pull_request') | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,153 @@ | ||
node_modules | ||
/bazel-bin | ||
/bazel-ci_build-cache | ||
/bazel-genfiles | ||
/bazel-out | ||
/bazel-serving | ||
/bazel-tensorflow | ||
/bazel-tensorflow_serving | ||
/bazel-testlogs | ||
/bazel-tf | ||
/bazel-workspace | ||
# LINT.IfChange | ||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
**/*.py[cod] | ||
**/*$py.class | ||
|
||
# C extensions | ||
**/*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
# build/ # build/ contains required files for building tfx packages. | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
wheels/ | ||
pip-wheel-metadata/ | ||
share/python-wheels/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
MANIFEST | ||
|
||
# Pip package build symlinks for "tfx" / "ml-pipelines-sdk" | ||
package_build/*/README*.md | ||
package_build/*/build | ||
package_build/*/dist | ||
package_build/*/setup.py | ||
package_build/*/tfx | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.nox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*.cover | ||
.hypothesis/ | ||
.pytest_cache/ | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
local_settings.py | ||
db.sqlite3 | ||
|
||
# Flask stuff: | ||
instance/ | ||
.webassets-cache | ||
|
||
# Scrapy stuff: | ||
.scrapy | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# Jupyter Notebook | ||
.ipynb_checkpoints | ||
|
||
# IPython | ||
profile_default/ | ||
ipython_config.py | ||
|
||
# pyenv | ||
.python-version | ||
|
||
# pipenv | ||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. | ||
# However, in case of collaboration, if having platform-specific dependencies or dependencies | ||
# having no cross-platform support, pipenv may install dependencies that don’t work, or not | ||
# install all needed dependencies. | ||
#Pipfile.lock | ||
|
||
# celery beat schedule file | ||
celerybeat-schedule | ||
|
||
# SageMath parsed files | ||
*.sage.py | ||
|
||
# Environments | ||
.env | ||
.venv | ||
env/ | ||
venv/ | ||
ENV/ | ||
env.bak/ | ||
venv.bak/ | ||
|
||
# Spyder project settings | ||
.spyderproject | ||
.spyproject | ||
|
||
# Rope project settings | ||
.ropeproject | ||
|
||
# Intellij project settings | ||
.idea | ||
|
||
# VSCode project settings | ||
.vscode | ||
|
||
# mkdocs documentation | ||
/site | ||
|
||
# mypy | ||
.mypy_cache/ | ||
.dmypy.json | ||
dmypy.json | ||
|
||
# Pyre type checker | ||
.pyre/ | ||
|
||
# Bazel generated files | ||
bazel-* | ||
**/*_pb2.py | ||
**/*_pb2_grpc.py | ||
# LINT.ThenChange(.dockerignore) | ||
|
||
MODULE.bazel | ||
MODULE.bazel.lock | ||
|
||
/third_party/py/numpy/numpy_include | ||
/util/python/python_include | ||
/util/python/python_lib | ||
|
||
# C++ API docs | ||
/tmp-cpp-api-docs |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.