-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
20 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
Makefile | ||
**/__pycache__ | ||
doc/build/* | ||
*.eps | ||
*~ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
doc/build/html/ |