Skip to content

Commit eb286eb

Browse files
sidey79sidey79
committed
docs: added docs for static site generator
1 parent 873e8a7 commit eb286eb

11 files changed

Lines changed: 130 additions & 0 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Documentation Build and Deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
concurrency:
13+
group: ${{ github.workflow }}-${{ github.ref }}
14+
permissions:
15+
contents: write # Für peaceiris/actions-gh-pages@v3
16+
pages: write
17+
id-token: write
18+
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
23+
# 1. docToolchain benötigt Java (Gradle-Basis)
24+
- name: Setup Java
25+
uses: actions/setup-java@v4
26+
with:
27+
distribution: 'temurin'
28+
java-version: '17'
29+
30+
# 2. docToolchain Wrapper herunterladen und ausführbar machen (dtcw)
31+
- name: Download docToolchain Wrapper
32+
run: |
33+
curl -Lo dtcw https://raw.githubusercontent.com/docToolchain/docToolchain/master/dtcw
34+
chmod +x dtcw
35+
36+
# 3. Dokumentation bauen (Build-Befehl aus docToolchain-Demo)
37+
# Die docToolchainConfig.groovy konfiguriert den Pfad auf 'docs'
38+
- name: Build Documentation
39+
run: ./dtcw buildHtml
40+
41+
# 4. Deployment zu gh-pages (peaceiris action, wie im Demo-Repo)
42+
- name: Deploy to GitHub Pages
43+
uses: peaceiris/actions-gh-pages@v3
44+
with:
45+
github_token: ${{ secrets.GITHUB_TOKEN }}
46+
publish_dir: ./docs/build/site/html # Ausgabepfad aus docToolchainConfig.groovy
47+
publish_branch: gh-pages

‎docToolchainConfig.groovy‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// docToolchain configuration file
2+
docToolchain {
3+
// Defines the directory where the documentation source files are located
4+
docDir = "docs"
5+
6+
// Configure the build to output to build/site/html for GitHub Pages deployment
7+
// (This is the expected artifact path in ./github/workflows/docs.yml)
8+
build.html5.outputDir = 'build/site/html'
9+
10+
// Configure Asciidoctor to use the :description: and :keywords: attributes
11+
// to generate the meta tags for search engine optimization.
12+
// 'docinfo': 'shared' is key to ensuring document info (like meta tags) is included.
13+
config.asciidoctorConfig = [
14+
attributes: [
15+
'docinfo': 'shared'
16+
]
17+
]
18+
}

‎docs/01_user_guide/index.adoc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
= Benutzer-Leitfaden
2+
:leveloffset: 1
3+
4+
Der Benutzer-Leitfaden enthält Anweisungen zur Installation, Konfiguration und grundlegenden Verwendung von PySignalduino.
5+
6+
include::installation.adoc[]
7+
include::usage.adoc[]

‎docs/01_user_guide/installation.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
== Installation
2+
3+
Details zur Installation von PySignalduino (z.B. mit pip, in FHEM).

‎docs/01_user_guide/usage.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
== Verwendung und Konfiguration
2+
3+
Beschreibung der grundlegenden API-Nutzung und der Konfigurationsmöglichkeiten.

‎docs/02_developer_guide/architecture.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
== Architektur
2+
3+
Details zum Aufbau von PySignalduino, insbesondere der Manchester Parsing Chain und der Protokoll-Implementierung.

‎docs/02_developer_guide/contribution.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
== Beitrag leisten (Contributing)
2+
3+
Anleitung, wie man Code beitragen, Probleme melden und Tests schreiben kann.

‎docs/02_developer_guide/index.adoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
= Entwickler-Leitfaden
2+
3+
Dieser Abschnitt beschreibt die Architektur, wie man zur Entwicklung beitragen kann (Contributing) und wie man Tests durchführt.
4+
5+
include::architecture.adoc[]
6+
include::contribution.adoc[]

‎docs/03_protocol_reference/index.adoc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
= Protokoll-Referenz
2+
3+
Eine detaillierte Referenz aller unterstützten Protokolle, deren Implementierungsdetails und bekannten Einschränkungen.
4+
5+
include::protocol_details.adoc[]

‎docs/03_protocol_reference/protocol_details.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
== Protokolldetails
2+
3+
Platzhalter für die detaillierte Beschreibung jedes unterstützten Protokolls.

0 commit comments

Comments
 (0)