docs_gen.yml

# This is a basic workflow to help you get started with Actions

name: Documentation

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
  pull_request:
  push:
    branches:
      - master
    paths:
      - 'docs/**'
      - 'octobot/**'
      - '.github/workflows/docs_gen.yml'

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.10'
        architecture: x64
    - uses: ammaraskar/sphinx-action@master
      with:
        pre-build-command: "sudo apt install libre2-dev && python3 -m pip install --upgrade poetry && poetry install --without dev -E pyre2"
        docs-folder: "docs/"

    - name: Generate commandlist.json
      run: |
        sudo apt install libre2-dev
        python3 -m pip install poetry
        python3 -m poetry install --without dev -E pyre2
        python3 -m poetry run python3 utils/dry_run.py
      env:
        ob_production: 'true'

    - name: Copy generated documentation to public folder
      run: cp docs/_build/html/* public/ -r

    # Create an artifact of the html output.
    - uses: actions/upload-artifact@v1
      with:
        name: DocumentationHTML
        path: public

    - name: Deploy to GitHub Pages
      if: ${{ github.event_name == 'push' }}
      uses: JamesIves/github-pages-deploy-action@3.7.1
      with:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        BRANCH: gh-pages # The branch the action should deploy to.
        FOLDER: public # The folder the action should deploy.
        CLEAN: true # Automatically remove deleted files from the deploy branch