Skip to content

Commit

Permalink
add github actions to deploy github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
yanghan-microsoft committed Sep 10, 2024
1 parent bf998e4 commit be74c4a
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/gh-pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Deploy Documentation to GitHub Pages

on:
push:
branches:
# - main # You can change this to your default branch
- docs

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9'

- name: Install dependencies
run: |
pip install sphinx sphinx-autodoc-typehints sphinx_book_theme sphinx-copybutton
pip install nbsphinx recommonmark Pygments
- name: Build the docs
run: |
cd docs
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
Empty file added .nojekyll
Empty file.

0 comments on commit be74c4a

Please sign in to comment.