github/workflows/main.yml

#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

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

name: CI

# Controls when the workflow will run
on: 
  # Triggers the workflow on push or pull request events but only for the distill_toolkit_refactor branch and on changes to the rst files
  push:
    branches: [ distill_toolkit_refactor ]
    paths:
      - docs/source/**
  pull_request:
    branches: [ distill_toolkit_refactor ]
    paths:
      - docs/source/**
    

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

# defines where the make html command will be executed
defaults:
  run:
    working-directory: ./docs
    
# 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 represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v1
      - uses: ammaraskar/sphinx-action@master
        with:
        docs-folder: "docs/"

      # Runs a single command using the runners shell
      #- name: Run Makefile to generate the htmls
        #run: make html