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

Open
wants to merge 38 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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 Sep 2, 2024
40e2829
Add basic documentation deployment workflow
smokestacklightnin Sep 2, 2024
bb78fe4
Add cache dependency path
smokestacklightnin Sep 2, 2024
5a8148d
Add empty index page
smokestacklightnin Sep 2, 2024
7012295
Fix internal links
smokestacklightnin Sep 2, 2024
407e1b5
Fix broken links
smokestacklightnin Sep 3, 2024
9efc0c2
Fix bash command listing
smokestacklightnin Sep 3, 2024
9689343
Fix virbatim text
smokestacklightnin Sep 3, 2024
8330c42
Fix broken link
smokestacklightnin Sep 3, 2024
b857e67
Fix broken link
smokestacklightnin Sep 3, 2024
bf4b58f
Fix broken links
smokestacklightnin Sep 3, 2024
c78f143
Add REST api docs
smokestacklightnin Sep 3, 2024
d9ee576
Add gRPC api docs
smokestacklightnin Sep 3, 2024
c794ab1
Reorganize guide and tutorial files and fix links
smokestacklightnin Sep 3, 2024
3af20e0
Add tutorials to docs
smokestacklightnin Sep 3, 2024
d3399f5
Fix admonitions
smokestacklightnin Sep 24, 2024
660d28d
Fix broken links
smokestacklightnin Sep 24, 2024
163c8f4
Move landing page to `index.md`
smokestacklightnin Sep 24, 2024
01951b3
Add white background to images
smokestacklightnin Sep 24, 2024
00e32b8
Add placeholder for C++ docs
smokestacklightnin Sep 24, 2024
81c9dce
Remove logo
smokestacklightnin Sep 24, 2024
65e463e
Change workflow triggers from debugging to production settings
smokestacklightnin Sep 24, 2024
0b70681
Add link to C++ api docs placeholder
smokestacklightnin Sep 24, 2024
f2dbc9d
Add build docs check on pull request
smokestacklightnin Sep 30, 2024
36e085f
Move docs to standard location; fix links
peytondmurray Oct 2, 2024
a04efb5
Bump Python version
smokestacklightnin Oct 14, 2024
ebbb44a
Move docs requirements to common location
smokestacklightnin Oct 14, 2024
d5ba899
Only trigger on push to `master`
smokestacklightnin Oct 14, 2024
3517b90
Build docs with Doxygen
smokestacklightnin Oct 15, 2024
f3d1c27
Install Doxygen in deploy GH action
smokestacklightnin Oct 15, 2024
7c1f2b4
Install `graphviz` to generate Doxygen diagrams
smokestacklightnin Oct 15, 2024
c45275d
Install doxygen with apt
smokestacklightnin Oct 15, 2024
eda9623
Fix link on homepage
smokestacklightnin Oct 15, 2024
42b45af
Remove commented import
smokestacklightnin Oct 15, 2024
1963415
Simplify url
smokestacklightnin Oct 15, 2024
f62049a
Add a splash page for the cpp docs; clean up hook; add gitignore
peytondmurray Oct 16, 2024
b14d621
Remove unused icon
smokestacklightnin Oct 16, 2024
caf3b72
Point to landing page
smokestacklightnin Oct 16, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/workflows/cd-docs.yml
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')
peytondmurray marked this conversation as resolved.
Show resolved Hide resolved
161 changes: 150 additions & 11 deletions .gitignore
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
Loading