Skip to content

Commit

Permalink
Update in deploy doc page action
Browse files Browse the repository at this point in the history
  • Loading branch information
fjganan14 committed Nov 24, 2024
1 parent 1193614 commit 1dfd10e
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions .github/workflows/deploy_mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: Deploy MkDocs
name: Deploy MkDocs Documentation

on:
push:
branches:
- main # Deploy only when pushing to the main branch
- main # Trigger workflow on push to the main branch

jobs:
deploy:
Expand All @@ -21,10 +21,18 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install install mkdocs mkdocstrings[python] mkdocs-autorefs mkdocs-material mkdocs-gen-files
pip install mkdocs mkdocstrings[python] mkdocs-autorefs mkdocs-material mkdocs-gen-files
- name: Generate API Reference Documentation
run: |
python docs/scripts/gen_ref_pages.py
echo "Generated reference documentation."
- name: Build MkDocs site
run: mkdocs build # Generates the static site in the ./site folder

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site # Directory where MkDocs builds the static site
github_token: ${{ secrets.TOKEN }}
publish_dir: ./site

0 comments on commit 1dfd10e

Please sign in to comment.