Skip to content

Commit

Permalink
chore: deploy docs preview on docs changes (#2403)
Browse files Browse the repository at this point in the history
  • Loading branch information
rchl authored Jan 26, 2024
1 parent cb31560 commit 9edc248
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: pip install mkdocs-material mkdocs-redirects
- run: |
cd docs
mkdocs gh-deploy --force
make install
make deploy
15 changes: 15 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Minimal makefile for Sphinx documentation

.PHONY: clean

install:
pip install mkdocs mkdocs-material mkdocs-redirects

build:
mkdocs build

deploy:
mkdocs gh-deploy --force

clean:
rm -rf site
6 changes: 6 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# https://docs.netlify.com/configure-builds/file-based-configuration

[build]
base = "docs/"
publish = "site/"
command = "make install && make build"

0 comments on commit 9edc248

Please sign in to comment.