Add GH Actions for building docs + update doc -> default settings

raspishake · Jan 12, 2025 · 4119b92 · 4119b92
1 parent e6a0d0f
commit 4119b92
Show file tree

Hide file tree

Showing 2 changed files with 100 additions and 28 deletions.
diff --git a/.github/workflows/deploy_docs_from_docsrc.yaml b/.github/workflows/deploy_docs_from_docsrc.yaml
@@ -0,0 +1,41 @@
+# Works only if github.event.release.tag_name == package version
+name: Build Docs
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+    paths:
+      - docsrc/**
+
+jobs:
+  build:
+    name: Build docs
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install Sphinx==8.1.3
+          pip install docutils==0.20.1
+          pip install sphinx_rtd_theme==3.0.2
+          pip install "Jinja2<3.1"
+      - name: Build
+        run: |
+          cd docsrc/
+          make github
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: builds
+          path: docsrc/_build/html
diff --git a/docsrc/settings.rst b/docsrc/settings.rst
@@ -628,66 +628,97 @@ By default, the settings are as follows:
 .. code-block:: json
 
     {
-    "settings": {
+      "settings": {
         "port": 8888,
         "station": "Z0000",
-        "output_dir": "@@DIR@@",
-        "debug": true},
-    "printdata": {
-        "enabled": false},
-    "write": {
+        "output_dir": "output_dir",
+        "debug": true
+      },
+      "printdata": {
+        "enabled": false
+      },
+      "write": {
         "enabled": false,
-        "channels": ["all"]},
-    "plot": {
+        "channels": [
+          "all"
+        ]
+      },
+      "plot": {
         "enabled": true,
         "duration": 90,
+        "refresh_interval": 0,
         "spectrogram": true,
         "fullscreen": false,
         "kiosk": false,
         "eq_screenshots": false,
-        "channels": ["all"],
+        "channels": [
+          "all"
+        ],
+        "filter_waveform": false,
+        "filter_spectrogram": false,
+        "filter_highpass": 0.7,
+        "filter_lowpass": 2.0,
+        "filter_corners": 4,
+        "spectrogram_freq_range": false,
+        "upper_limit": 15.0,
+        "lower_limit": 0.0,
+        "logarithmic_y_axis": false,
         "deconvolve": true,
-        "units": "CHAN"},
-    "forward": {
+        "units": "CHAN"
+      },
+      "forward": {
         "enabled": false,
-        "address": ["192.168.1.254"],
-        "port": [8888],
-        "channels": ["all"],
+        "address": [
+          "192.168.1.254"
+        ],
+        "port": [
+          8888
+        ],
+        "channels": [
+          "all"
+        ],
         "fwd_data": true,
-        "fwd_alarms": false},
-    "alert": {
+        "fwd_alarms": false
+      },
+      "alert": {
         "enabled": true,
         "channel": "HZ",
         "sta": 6,
         "lta": 30,
+        "duration": 0.0,
         "threshold": 3.95,
         "reset": 0.9,
         "highpass": 0.8,
         "lowpass": 9,
         "deconvolve": false,
-        "units": "VEL"},
-    "alertsound": {
+        "units": "VEL"
+      },
+      "alertsound": {
         "enabled": false,
-        "mp3file": "doorbell"},
-    "custom": {
+        "mp3file": "doorbell"
+      },
+      "custom": {
         "enabled": false,
         "codefile": "n/a",
-        "win_override": false},
-    "tweets": {
+        "win_override": false
+      },
+      "tweets": {
         "enabled": false,
         "tweet_images": true,
         "api_key": "n/a",
         "api_secret": "n/a",
         "access_token": "n/a",
         "access_secret": "n/a",
-        "extra_text": ""},
-    "telegram": {
+        "extra_text": ""
+      },
+      "telegram": {
         "enabled": false,
         "send_images": true,
         "token": "n/a",
         "chat_id": "n/a",
-        "extra_text": ""},
-    "rsam": {
+        "extra_text": ""
+      },
+      "rsam": {
         "enabled": false,
         "quiet": true,
         "fwaddr": "192.168.1.254",
@@ -696,10 +727,10 @@ By default, the settings are as follows:
         "channel": "HZ",
         "interval": 10,
         "deconvolve": false,
-        "units": "VEL"}
+        "units": "VEL"
+      }
     }
 
-
 ................
 
 * :ref:`genindex`