From 3aa1fc735c1208920b7d88b6e5b51a672ed08d91 Mon Sep 17 00:00:00 2001 From: labrec_b Date: Wed, 29 Jul 2026 16:32:32 +0200 Subject: [PATCH] feat: add Gitea Pages documentation (#43) feat: add Gitea Pages documentation --------- Co-authored-by: Benjamin Labrecque Reviewed-on: https://gitea.psi.ch/sls/hla_framework_bd/pulls/43 --- .gitea/workflows/publish-site.yml | 36 ++++++++++++ docs-unpublished/README.md | 3 + {docs/developer => docs-unpublished}/steps.md | 0 docs/developer/cicd_runner.md | 8 +-- docs/index.md | 3 + zensical.toml | 56 +++++++++++++++++++ 6 files changed, 102 insertions(+), 4 deletions(-) create mode 100644 .gitea/workflows/publish-site.yml create mode 100644 docs-unpublished/README.md rename {docs/developer => docs-unpublished}/steps.md (100%) create mode 100644 docs/index.md create mode 100644 zensical.toml diff --git a/.gitea/workflows/publish-site.yml b/.gitea/workflows/publish-site.yml new file mode 100644 index 0000000..7d15203 --- /dev/null +++ b/.gitea/workflows/publish-site.yml @@ -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 diff --git a/docs-unpublished/README.md b/docs-unpublished/README.md new file mode 100644 index 0000000..a819865 --- /dev/null +++ b/docs-unpublished/README.md @@ -0,0 +1,3 @@ +# Unpublished docs + +Any docs in this subfolder will not be published to the Gitea Pages docs. diff --git a/docs/developer/steps.md b/docs-unpublished/steps.md similarity index 100% rename from docs/developer/steps.md rename to docs-unpublished/steps.md diff --git a/docs/developer/cicd_runner.md b/docs/developer/cicd_runner.md index a69e6f4..a43584d 100644 --- a/docs/developer/cicd_runner.md +++ b/docs/developer/cicd_runner.md @@ -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`) ``` diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..0d87f82 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Overview + +Documentation for the SLS 2.0 High Level Applications Framework diff --git a/zensical.toml b/zensical.toml new file mode 100644 index 0000000..7e44c89 --- /dev/null +++ b/zensical.toml @@ -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 © 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"