build-docs.yml

name: Build(Docs)

# Controls when the action will run.
on:
  # Triggers the workflow on all branches
  push:
    branches: '*'
  pull_request:
    branches: '*'

  # 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-docs:
    # 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:
    - uses: actions/checkout@v2
    - name: Set up Python 3.9
      uses: actions/setup-python@v2
      with:
        # Semantic version range syntax or exact version of a Python version
        python-version: '3.9'

    - name: Install package
      run: pip install -e .

      # Runs a set of commands using the runners shell
    - name: Build Documentation 📝
      run: |
        pip install pdoc3
        pdoc --html tfrec