From be74c4a7b25f9c93ada17905b04b16cd10a987e0 Mon Sep 17 00:00:00 2001 From: Han Yang Date: Tue, 10 Sep 2024 07:37:26 +0000 Subject: [PATCH] add github actions to deploy github pages --- .github/workflows/gh-pages.yaml | 36 +++++++++++++++++++++++++++++++++ .nojekyll | 0 2 files changed, 36 insertions(+) create mode 100644 .github/workflows/gh-pages.yaml create mode 100644 .nojekyll diff --git a/.github/workflows/gh-pages.yaml b/.github/workflows/gh-pages.yaml new file mode 100644 index 0000000..fd499cb --- /dev/null +++ b/.github/workflows/gh-pages.yaml @@ -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 \ No newline at end of file diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29