From fa18d60c1162d7cbe9d3eefcca129dc37340de79 Mon Sep 17 00:00:00 2001 From: Kelly Sovacool Date: Tue, 21 Jan 2025 11:05:40 -0500 Subject: [PATCH] ci: build docs site with mkdocs workflow copied with: ccbr_actions use-example docs-mkdocs --- .github/workflows/docs-mkdocs.yml | 28 ++++++++++++++++++++++++++++ docs/requirements.txt | 13 +++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 .github/workflows/docs-mkdocs.yml create mode 100644 docs/requirements.txt diff --git a/.github/workflows/docs-mkdocs.yml b/.github/workflows/docs-mkdocs.yml new file mode 100644 index 0000000..814e2a4 --- /dev/null +++ b/.github/workflows/docs-mkdocs.yml @@ -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 }} diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..083b20b --- /dev/null +++ b/docs/requirements.txt @@ -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