Skip to content

Commit

Permalink
docs: stop using mkdocs-deploy-gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-matsui committed Dec 12, 2024
1 parent 4977be6 commit b14eba4
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 7 deletions.
41 changes: 34 additions & 7 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,43 @@ name: Docs
on:
push:
branches: [main]
pull_request:

jobs:
build-and-deploy:
name: "build & deploy"
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CUSTOM_DOMAIN: docs.poac.dev
- uses: actions/setup-python@v5
with:
python-version: '3.x'
cache: 'pip'

- name: Install mkdocs
run: pip install mkdocs

- name: Build docs
run: mkdocs build --strict

deploy:
if: github.ref == 'refs/heads/main'
needs: build

permissions:
contents: write

runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: '3.x'
cache: 'pip'

- name: Install mkdocs
run: pip install mkdocs

- name: Publish docs
run: mkdocs gh-deploy --no-history
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@ poac-out/

# Doxygen
html

# MkDocs
site/
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.poac.dev

0 comments on commit b14eba4

Please sign in to comment.