feat: add Gitea Pages documentation (#43)
Build and Publish Site / docker (push) Successful in 3s

feat: add Gitea Pages documentation

---------

Co-authored-by: Benjamin Labrecque <labrecque.benji@gmail.com>
Reviewed-on: #43
This commit was merged in pull request #43.
This commit is contained in:
2026-07-29 16:32:32 +02:00
co-authored by Benjamin Labrecque
parent f62f0ec2aa
commit 3aa1fc735c
6 changed files with 102 additions and 4 deletions
+36
View File
@@ -0,0 +1,36 @@
name: Build and Publish Site
on:
push:
branches:
- main
- feature/add-gitea-pages-docs
paths:
- 'docs/**'
workflow_dispatch:
jobs:
docker:
runs-on: ubuntu-latest-intranet
container:
image: gitea.psi.ch/images/alpine-zensical
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build page
run: /opt/python-env/bin/zensical build
- name: Configure Git
run: |
git config --global user.name "Gitea Actions"
git config --global user.email "actions@gitea.local"
- name: Push to gitea-pages branch
run: |
git checkout --orphan gitea-pages
git reset --hard
mv site/* .
git add .
git commit -m "Update site - $(date)"
git push -f https://${{ secrets.GITHUB_TOKEN }}@gitea.psi.ch/${{ github.repository }}.git gitea-pages
+3
View File
@@ -0,0 +1,3 @@
# Unpublished docs
Any docs in this subfolder will not be published to the Gitea Pages docs.
+4 -4
View File
@@ -3,16 +3,16 @@
## Hosts
- `sls-vserv-bd-01(-dev)`
- Runs shellbox commands (and `ioc install ...`?)
- Runs shellbox commands (and `ioc install ...`?)
- `sls-vserv-bd-hla01(-dev)`
- Runs everything else
- Runs everything else
## Setup
Resources:
- https://docs.gitea.com/usage/actions/act-runner
- https://linux.psi.ch/documentation/services/gitea/gitea-runner/
- https://docs.gitea.com/usage/actions/act-runner
- https://linux.psi.ch/documentation/services/gitea/gitea-runner/
Register the runner: (by default the name is the machine name `sls-vserv-bd-hla01-dev.psi.ch`)
```
+3
View File
@@ -0,0 +1,3 @@
# Overview
Documentation for the SLS 2.0 High Level Applications Framework
+56
View File
@@ -0,0 +1,56 @@
[project]
repo_url = "https://gitea.psi.ch/sls/hla_framework_bd"
edit_uri = "_edit/main/docs/"
site_name = "SLS 2.0 High Level Applications Framework"
site_description = """
Documentation for SLS 2.0 High Level Applications Framework
"""
site_author = "Paul Scherrer Institute"
site_url = "https://sls.pages.psi.ch/hla_framework_bd/"
copyright = """
Copyright &copy; 2026 Paul Scherrer Institute
"""
language = "en"
features = [
"announce.dismiss",
"content.action.edit",
"content.code.annotate",
"content.code.copy",
"content.code.select",
"content.footnote.tooltips",
"content.tabs.link",
"content.tooltips",
"navigation.footer",
"navigation.indexes",
"navigation.instant",
"navigation.instant.prefetch",
"navigation.path",
"search.highlight",
"navigation.top",
"navigation.tracking",
]
[project.theme]
# do not use google fonts
font = false
[[project.theme.palette]]
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"
[[project.theme.palette]]
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"
[project.theme.icon]
logo = "simple/gitea"
repo = "simple/gitea"