Skip to content

Commit

Permalink
Add documentation build CI routine
Browse files Browse the repository at this point in the history
  • Loading branch information
mkosunen committed Jan 22, 2024
1 parent aa682ba commit cbc6818
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 27 deletions.
33 changes: 7 additions & 26 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
@@ -1,40 +1,21 @@
on:
push:
branches:
- v1.9_RC
- master
- v1.11_RC

jobs:
doc_build_job:
runs-on: ubuntu-latest
# This project MUST be given permission to use the image blow. at
# Package settings-> Manage action access of the project hosting the
# package
# Your project MUSTT contain empty .nojekyll file. Github Pages will
# discard everything starting with '_' i.e. the stylefiles.
container: 'ghcr.io/thesystemdevelopmentkit/thesdktestimage:latest'
name: Test the submodules and Update the thesdk_template
name: Build documentation
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Test and update
run: ./CI-helpers/test_and_release.sh -c -b "v1.9_RC" -t ${{ secrets.THESYDEKICK_TOKEN }}

## This is an example how to run a image pull if needed.
# image_pull:
# runs-on: ubuntu-latest
# name: Pull docker image
# steps:
# - name: Login to Github Packages
# uses: docker/login-action@v1
# with:
# registry: ghcr.io
# username: ${{ github.actor }}
# password: ${{ secrets.GITHUB_TOKEN}}
#
# - name: Pull image
# uses: docker/login-action@v1
# with:
# registry: ghcr.io
# username: ${{ github.actor }}
# password: ${{ secrets.GITHUB_TOKEN}}
# - name: Pull Docker image
# run: docker pull 'ghcr.io/thesystemdevelopmentkit/thesdktestimage:latest'

- name: Documentation builder action
run: cd doc && make html && cd .. && rm -rf ./docs && mv ./doc/build/html/* ./docs/
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
Makefile
**/__pycache__
doc/build/*
*.eps
*.pdf
*~
Expand Down
12 changes: 12 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Documentation

Default page, if exists, is https://TheSystemDevelopmentKit.github.io/inverter/

The 'docs' directory is a symbolic link to doc/build/html for github CI documentation builds.

Github documentation flow is defined in .github/workflows/main.yaml

The file ./doc/build/html.nojekyll is mandatory for Gitlab pages to parse
files and directories starting with '_'.


Empty file added doc/build/html/.nojekyll
Empty file.
1 change: 1 addition & 0 deletions docs

0 comments on commit cbc6818

Please sign in to comment.