Skip to content

Commit

Permalink
Fix gh-pages automation (#13)
Browse files Browse the repository at this point in the history
* since this should only run on merge with main, we have to assume tests are passing.
* added requirements file to please mkdocs

---------

Signed-off-by: apetrynet <flehnerheener@gmail.com>
Signed-off-by: Daniel Flehner Heen <flehnerheener@gmail.com>
  • Loading branch information
apetrynet authored Mar 6, 2024
1 parent 7557c26 commit ec1a1e6
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 13 deletions.
28 changes: 15 additions & 13 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,19 @@ jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
needs: test_pyfdl
permissions:
contents: write
steps:
- name: Checkout main
uses: actions/checkout@v3

- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install mkdocs mktestdocs
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@nomaterial
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.11
- run: |
pip install -r requirements.txt
# Install pyfdl
pip install .
- run: mkdocs build --clean
- uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
8 changes: 8 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
build
mkdocs
pytest
jsonschema
mktestdocs
mkdocstrings
mkdocstrings-python
mkdocs-autorefs

0 comments on commit ec1a1e6

Please sign in to comment.