forked from OpenSTEF/openstef
-
Notifications
You must be signed in to change notification settings - Fork 0
34 lines (32 loc) · 974 Bytes
/
docs-check.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project
#
# SPDX-License-Identifier: MPL-2.0
name: Docs Check
# Check docs when directly editing develop or main
# and on pull request
on:
push:
branches:
- main
pull_request:
branches:
- "**"
jobs:
docs:
runs-on: ubuntu-latest
steps:
# Checkout
- name: Checkout code
uses: actions/checkout@v2
# Build documentation
- name: Build documentation
uses: ammaraskar/sphinx-action@master
with:
pre-build-command: |
cp requirements.txt docs/requirements.txt &&\
printf "\npydata-sphinx-theme==0.8.1\n" >> docs/requirements.txt &&\
printf "\njinja2==3.0.0\n" >> docs/requirements.txt &&\
printf "\nsphinx_autodoc_typehints==1.19.4\n" >> docs/requirements.txt &&\
printf "\nmkdocs==1.2.3\n" >> docs/requirements.txt &&\
sphinx-apidoc -o docs openstef
docs-folder: "docs/"