Files
openshot-qt/.github/workflows/sphinx.yml
dependabot[bot] 1b6b1c5e2e Bump actions/upload-artifact from 2.2.3 to 2.2.4 (#4201)
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 2.2.3 to 2.2.4.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v2.2.3...v2.2.4)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-26 15:25:17 -04:00

33 lines
1016 B
YAML

# Github Actions workflow to generate documentation
# Uses the following shared task definitions:
# - (checkout, upload artifact) from Github
# - sphinx-action maintained by @ammaraskar
name: Sphinx build
# Controls when the action will run.
# Triggers the workflow on push or pull request events.
on:
- push
- pull_request
# 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 are a sequence of tasks that will be executed as part of the job
steps:
# Check out repository under $GITHUB_WORKSPACE
- uses: actions/checkout@v2
# Builds docs using sphinx
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "doc/"
# Create an artifact out of the generated HTML
- uses: actions/upload-artifact@v2.2.4
with:
name: UserGuideHTML
path: "doc/_build/html/"