publish_docs.yml

name: Publish Docs
on:
  push:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v3
      with:
        fetch-depth: 0
    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.10'
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        cd docs
        pip install -r requirements.txt
    - name: Show contents of working dir
      working-directory: ./docs
      run: |
        ls -la $PWD
    - name: Build sphinx documentation
      working-directory: ./docs
      run: |
        make html
        cd _build/html
        touch .nojekyll
    - name: Create documentation artifact
      run: |
        tar -cvf docs_build.tar _build/html
    - name: 'Upload artifact'
      uses: actions/upload-artifact@v3
      with:
        name: github-pages
        path: ./docs_build.tar

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment: github-pages
    steps:
    - name: Publish on GitHub pages
      uses: actions/deploy-pages@v1
      with:
        token: ${{ secrets.GITHUB_TOKEN }}