Skip to content

Fix: Broken image links and version drop-down on documentation website #182

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 25 additions & 10 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: docs

on:
pull_request:
branches:
- "**"
push:
branches:
- master
Expand All @@ -9,19 +12,31 @@ permissions:
contents: write

jobs:
deploy-docs:
deploy-docs-version:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install -r ./docs/requirements.txt
- run: mkdocs gh-deploy --force
- name: Set release notes tag
run: |
export RELEASE_TAG_VERSION=${{ github.event.release.tag_name }}
echo "RELEASE_TAG_VERSION=${RELEASE_TAG_VERSION:1}" >> $GITHUB_ENV
- name: Install dependencies
run: pip install -r ./docs/requirements.txt
- name: Set up Git config
run: |
git config --global user.name ci-bot
git config --global user.email [email protected]
git config --global pull.rebase false
git lfs install
git lfs pull
git fetch origin gh-pages --depth=1
git pull origin gh-pages --depth=1 --allow-unrelated-histories
- name: Deploy docs website and API reference
run: |
mike deploy --push --force --ignore --update-aliases ${RELEASE_TAG_VERSION} latest
mike set-default --push latest
30 changes: 0 additions & 30 deletions .github/workflows/docs_version_control.yml

This file was deleted.