[Docs] Use mkdocs
for documentation
#4
Workflow file for this run
This file contains 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
name: deploy-docs | |
on: | |
workflow_dispatch: | |
push: | |
pull_request: | |
permissions: | |
contents: write | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- name: Configure Git Credentials | |
run: | | |
git config user.name github-actions[bot] | |
git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
if: (github.event_name != 'pull_request') | |
- 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: pip install mkdocs mkdocs-material mkdocstrings[python] griffe-inherited-docstrings mkdocs-autorefs black mkdocs-jupyter mkdocs-caption mkdocstrings-c | |
- name: Deploy to GitHub Pages | |
run: mkdocs gh-deploy --force | |
if: (github.event_name != 'pull_request') | |
- name: Build docs to check for errors | |
run: mkdocs build --verbose | |
if: (github.event_name == 'pull_request') |