docs.yml

# This is a basic workflow to help you get started with Actions
name: Build documentation

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the master branch
  push:
    branches: [ main ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:

    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    steps:
      - name: Setup python
        uses: actions/setup-python@v2
        with:
            python-version: '3.8'
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
      - name: Setup dependencies
        run: |
          sudo apt-get update
          sudo apt-get install python3-sphinx pandoc doxygen
          python -m pip install --upgrade pip
          python -m pip install sphinx_rtd_theme unidecode nbsphinx wheel breathe exhale sphinx_mdinclude myst-parser
      - name: Build and commit
        uses: sphinx-notes/pages@v2
        with:
          documentation_path: './docs'
      - name: Push documentation
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages