action.yml

name: 'Sphinx Build'
description: 'Builds documentation using Sphinx'
author: 'Wouter Kayser'
branding:
  icon: 'book'
  color: 'yellow'
inputs:
  docs-folder:
    description:
      The folder containing your sphinx docs.
    required: false
    default: "docs/"
  build-command:
    description:
      The command used to build your documentation.
    required: false
    default: make html
  pre-build-command:
    description:
      Run before the build command, you can use this to install system level
      dependencies, for example with
      "apt-get update -y && apt-get install -y perl"
    required: false

runs:
  using: "composite"
  steps:
    - run: ${{ github.action_path }}/entrypoint.py
      shell: bash
      env:
        DOCS_FOLDER: ${{inputs.docs-folder}}
        BUILD_COMMAND: ${{inputs.build-command}}
        PRE_BUILD_COMMAND: ${{inputs.pre-build-command}}