Skip to content

Commit

Permalink
ci: build docs site with mkdocs
Browse files Browse the repository at this point in the history
workflow copied with:
    ccbr_actions use-example docs-mkdocs
  • Loading branch information
kelly-sovacool committed Jan 21, 2025
1 parent 163841c commit fa18d60
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/docs-mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: docs
# this workflow requires:
# - an mkdocs config file (`mkdocs.yml`)
# - website dependencies in `docs/requirements.txt`
on:
workflow_dispatch:
release:
types:
- published
push:
branches:
- main
paths:
- "docs/**"
- "**.md"
- .github/workflows/docs-mkdocs.yml
- mkdocs.yml

jobs:
mkdocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: CCBR/actions/mkdocs-mike@v0.1
with:
github-token: ${{ github.token }}
13 changes: 13 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
mkdocs
#https://pypi.org/project/mkdocs-git-revision-date-localized-plugin/
mkdocs-git-revision-date-localized-plugin
#https://pypi.org/project/mkdocs-minify-plugin/
mkdocs-minify-plugin
#https://pypi.org/project/mkdocs-git-revision-date-plugin/
mkdocs-git-revision-date-plugin
#https://pypi.org/project/mkdocs-material/
mkdocs-material
#https://pypi.org/project/mkdocs-material-extensions/
mkdocs-material-extensions
#https://github.com/jimporter/mike
mike

0 comments on commit fa18d60

Please sign in to comment.