Skip to content

Commit

Permalink
docs: Added contributors to generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BottlecapDave committed Jun 29, 2024
1 parent 757e873 commit dbfa3de
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
16 changes: 14 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,21 @@ on:
paths:
- 'mkdocs.yml'
- '_docs/**'

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
build_docs:
if: ${{ (github.repository_owner == 'BottlecapDave' && (github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main')) == false }}
name: Build docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
sparse-checkout: |
_docs
- uses: actions/setup-python@v4
with:
python-version: 3.x
Expand All @@ -22,7 +30,7 @@ jobs:
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: pip install -r requirements.txt
- run: mkdocs build --strict

deploy_docs:
Expand All @@ -33,6 +41,10 @@ jobs:
contents: write
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
sparse-checkout: |
_docs
- uses: actions/setup-python@v4
with:
python-version: 3.x
Expand All @@ -43,5 +55,5 @@ jobs:
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: pip install -r requirements.txt
- run: mkdocs gh-deploy --strict --force
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ markdown_extensions:
- toc:
permalink: "#"

plugins:
- search
- git-authors:
show_email_address: false

theme:
name: material
features:
Expand Down
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
mkdocs-material==9.5.1
mike==2.0.0
mike==2.0.0
mkdocs-git-authors-plugin==0.9.0

0 comments on commit dbfa3de

Please sign in to comment.