Include documentation scripts

.github/scripts/build-doc.sh

@@ -7,6 +7,6 @@ eval "$(opam config env)"
 OCAMLPATH="$(cat ../.ocamlpath)"
 export OCAMLPATH
 
-opam install -y odoc
+opam install -y odoc pandoc-include
 dune build @doc
 dune build --profile release ./src/js/interactive_js.bc.js

.github/scripts/build-posix.sh

@@ -39,6 +39,7 @@ export PKG_CONFIG_PATH=/usr/share/pkgconfig/pkgconfig
 
 opam update
 opam install -y re.1.11.0
+opam install -y pandoc-include
 
 echo "::endgroup::"
 

.github/workflows/ci.yml

@@ -218,7 +218,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        target: ["@citest", "@mediatest"]
+        target: ["@citest", "@doctest", "@mediatest"]
     env:
       HOME: /home/opam
     steps:
@@ -245,13 +245,18 @@ jobs:
           cd /tmp/liquidsoap-full/liquidsoap
           # TMP
           sudo -u opam -E ./.github/scripts/add-local-opam-packages.sh
-          sudo -u opam -E opam install -y ssl.0.7.0
+          sudo -u opam -E opam install -y ssl.0.7.0 pandoc-include
           sudo -u opam -E ./.github/scripts/build-posix.sh "${{ steps.cpu_cores.outputs.count }}"
           cp /tmp/liquidsoap-full/liquidsoap/_build/default/src/bin/liquidsoap.exe /tmp/${{ github.run_number }}/core/liquidsoap
       - name: Compute stats
         run: |
           cd /tmp/liquidsoap-full/liquidsoap
           sudo -u opam -E ./.github/scripts/stats-posix.sh
+      - name: Install additional packages
+        if: matrix.target == '@doctest'
+        run: |
+          sudo apt-get -y update
+          sudo apt-get -y install frei0r-plugins
       - name: Run tests
         env:
           CPU_CORES: ${{ steps.cpu_cores.outputs.count }}
@@ -270,7 +275,7 @@ jobs:
           name: metrics
           path: ${{ github.workspace }}/${{ github.run_number }}/metrics
       - name: Upload metrics
-        if: needs.build_details.outputs.is_fork != 'true' && matrix.target != '@mediatest'
+        if: needs.build_details.outputs.is_fork != 'true' && matrix.target == '@citest'
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

CHANGES.md

@@ -14,6 +14,7 @@ New:
 - Add `compute` parameter to `file.replaygain` to control gain calculation (#3438).
 - Add `compute` parameter to `enable_replaygain_metadata` to control replay gain calculation (#3438).
 - Add `copy:` protocol (##3506)
+- Add `file.touch`.
 
 Changed:
 

doc/Makefile

@@ -0,0 +1,17 @@
+MD = $(wildcard content/*.md)
+
+all: dune
+	@dune build @doc
+
+test: dune
+	@for i in $(MD); do \
+	echo -n "Compiling $$i... "; \
+	pandoc --filter=pandoc-include --metadata title="bla" --template=template.html $$i -o /tmp/`basename $$i .md`.html; \
+	echo "done"; \
+	done
+	@dune build @doctest
+
+dune:
+	@dune build @gendune --auto-promote
+
+.PHONY: dune

doc/content/complete_case.md

@@ -15,60 +15,8 @@ Once you've managed to describe what you want in such a modular way, you're half
 
 Now here is how to write that in [Liquidsoap](index.html).
 
-```liquidsoap
-#!/usr/bin/liquidsoap
-
-# Lines starting with # are comments, they are ignored.
-
-# Put the log file in some directory where
-# you have permission to write.
-log.file.path := "/tmp/<script>.log"
-# Print log messages to the console,
-# can also be done by passing the -v option to liquidsoap.
-log.stdout := true
-# Use the telnet server for requests
-settings.server.telnet := true
-
-# A bunch of files and playlists,
-# supposedly all located in the same base dir.
-
-default = single("~/radio/default.ogg")
-
-day     = playlist("~/radio/day.pls")
-night   = playlist("~/radio/night.pls")
-jingles = playlist("~/radio/jingles.pls")
-clock   = single("~/radio/clock.ogg")
-
-# Play user requests if there are any,
-# otherwise one of our playlists,
-# and the default file if anything goes wrong.
-radio = fallback([ request.queue(id="request"),
-                    switch([({ 6h-22h }, day),
-                            ({ 22h-6h }, night)]),
-                    default])
-# Add the normal jingles
-radio = random(weights=[1,5],[ jingles, radio ])
-# And the clock jingle
-radio = add([radio, switch([({0m0s},clock)])])
-
-# Add the ability to relay live shows
-full =
-  fallback(track_sensitive=false,
-           [input.http("http://localhost:8000/live.ogg"),
-            radio])
-
-# Output the full stream in OGG and MP3
-output.icecast(%mp3,
-  host="localhost",port=8000,password="hackme",
-  mount="radio",full)
-output.icecast(%vorbis,
-  host="localhost",port=8000,password="hackme",
-  mount="radio.ogg",full)
+```{.liquidsoap include="content/liq/complete-case.liq"}
 
-# Output the stream without live in OGG
-output.icecast(%vorbis,
-  host="localhost",port=8000,password="hackme",
-  mount="radio_nolive.ogg",radio)
 ```
 
 To try this example you need to edit the file names. In order to witness the switch from one playlist to another you can change the time intervals. If it is 16:42, try the intervals `0h-16h45` and `16h45-24h` instead of `6h-22h` and `22h-6h`. To witness the clock jingle, you can ask for it to be played every minute by using the `0s` interval instead of `0m0s`.