Skip to content

Commit

Permalink
add deploy doc
Browse files Browse the repository at this point in the history
  • Loading branch information
lwj-st committed Aug 7, 2024
1 parent 75ed552 commit 994a06d
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/deploy_doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Deploy Documentation

on:
push:
branches:
- main
- lwj/deploy_doc
pull_request:
branches:
- main

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
fetch-depth: 0

- name: Set up python
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: Install dependencies
run: |
pip install -r requirements.txt
pip install -r docs/requirements.txt
python docs/add_docstrings.py
- name: Start MkDocs server
id: start_server
run: |
mkdocs serve -a localhost:1369 &
- name: Wait for server to start
run: sleep 100

- name: Check if MkDocs server is running
run: |
curl --silent --fail http://localhost:1369 || (echo "MkDocs server failed to start" && exit 1)

0 comments on commit 994a06d

Please sign in to comment.