Skip to content

Commit

Permalink
Adds ci/cd for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
domna committed Jan 15, 2024
1 parent 696624c commit 931ffaf
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: build_docs
on:
push:
branches: [master]
pull_request:
branches: [master]
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v4
with:
python-version: 3.x
- 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 mkdocs-requirements.txt
- run: mkdocs gh-deploy --force
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ cython_debug/
*.txt
!requirements.txt
!dev-requirements.txt
!mkdocs-requirements.txt
build/
nexusparser.egg-info/PKG-INFO
.python-version
4 changes: 4 additions & 0 deletions mkdocs-requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
mkdocs
mkdocs-material
mkdocs-material-extensions
mkdocs-macros-plugin

0 comments on commit 931ffaf

Please sign in to comment.