Skip to content

Commit efcd44b

Browse files
added the doc build in the workflows
1 parent 538241b commit efcd44b

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

.github/workflows/_build_doc.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# -*- coding: utf-8 -*-
2+
# Copyright (C) 2023 Benjamin Thomas Schwertfeger
3+
# Github: https://github.com/btschwertfeger
4+
#
5+
# Template workflow to build documentation.
6+
#
7+
8+
name: Build Doc
9+
10+
on:
11+
workflow_call:
12+
inputs:
13+
os:
14+
type: string
15+
required: true
16+
python-version:
17+
type: string
18+
required: true
19+
20+
jobs:
21+
Build:
22+
runs-on: ${{ inputs.os }}
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v3
26+
27+
- name: Set up Python ${{ inputs.python-version }}
28+
uses: actions/setup-python@v4
29+
with:
30+
python-version: ${{ inputs.python-version }}
31+
32+
- name: Install dependencies
33+
run: |
34+
python -m pip install --upgrade pip
35+
python -m pip install -r docs/requirements.txt
36+
37+
- name: Build the documentation
38+
run: cd docs && make html

.github/workflows/cicd.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ jobs:
3737
os: ${{ matrix.os }}
3838
python-version: ${{ matrix.python-version }}
3939

40+
## Build the documentation
41+
##
42+
Build-Doc:
43+
needs: [Pre-Commit]
44+
uses: ./.github/workflows/_build_doc.yml
45+
with:
46+
os: "ubuntu-latest"
47+
python-version: "3.11"
48+
4049
## Run the unit tests for Python 3.8 until 3.11
4150
##
4251
Test:

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ del*.py
135135
*.csv
136136
*.log
137137
*.zip
138+
.vscode/
138139

139140
*.egg-info/
140141
conda.stuff/

0 commit comments

Comments
 (0)