diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000000..a8d517efab --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,2 @@ +all: + @dune build @doc diff --git a/doc/content/.gitignore b/doc/content/.gitignore deleted file mode 100644 index 8636e652db..0000000000 --- a/doc/content/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -reference.md -protocols.md -settings.md diff --git a/doc/content/liq/liquidsoap b/doc/content/liq/liquidsoap new file mode 100755 index 0000000000..04617f8f0e --- /dev/null +++ b/doc/content/liq/liquidsoap @@ -0,0 +1,4 @@ +#!/bin/sh +# shellcheck disable=SC2068 + +../../../liquidsoap $@ diff --git a/doc/content/liq/space_overhead.liq b/doc/content/liq/space_overhead.liq new file mode 100755 index 0000000000..a08d58c3a5 --- /dev/null +++ b/doc/content/liq/space_overhead.liq @@ -0,0 +1,9 @@ +#!./liquidsoap +# This code was contributed by AzuraCast. Possible settings: +# - less memory: space_overhead = 20 +# - less cpu: space_overhead = 140 +# - balanced: space_overhead = 80 + +# Optimize for memory usage over CPU: this results in a slightly increased CPU +# usage and reduced memory usage. +runtime.gc.set(runtime.gc.get().{space_overhead=20, allocation_policy=2}) diff --git a/doc/content/memory.md b/doc/content/memory.md index a888419d0f..f835e9eb23 100644 --- a/doc/content/memory.md +++ b/doc/content/memory.md @@ -28,20 +28,8 @@ Inside liquidsoap scripts, the operations that the OCaml compiler provides to co Typically, to change the garbage collector parameters, one can do: -```liquidsoap -# This code was contributed by AzuraCast: -# Possible settings: -# - less memory: space_overhead = 20 -# - less cpu: space_overhead = 140 -# - balanced: space_overhead = 80 - -# Optimize for memory usage over CPU -# This results in a slightly increased -# CPU usage and reduced memory usage. -runtime.gc.set(runtime.gc.get().{ - space_overhead = 20, - allocation_policy = 2 -}) +```{.liquidsoap include="content/liq/space_overhead.liq" from=1} + ``` These parameters and functions make it possible to experiment and see if you can find better parameters for your application. diff --git a/doc/dune.inc b/doc/dune.inc index fa27f4c595..d6dea3c491 100644 --- a/doc/dune.inc +++ b/doc/dune.inc @@ -68,11 +68,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md protocols.md)) (target protocols.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=protocols --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=protocols --template=template.html -o %{target})))) (rule (alias doc) @@ -88,11 +89,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md reference.md)) (target reference.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=reference --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=reference --template=template.html -o %{target})))) (rule (alias doc) @@ -108,11 +110,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md reference-extras.md)) (target reference-extras.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=reference-extras --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=reference-extras --template=template.html -o %{target})))) (rule (alias doc) @@ -128,11 +131,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md reference-deprecated.md)) (target reference-deprecated.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=reference-deprecated --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=reference-deprecated --template=template.html -o %{target})))) (rule (alias doc) @@ -148,11 +152,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md settings.md)) (target settings.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=settings --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=settings --template=template.html -o %{target})))) (rule (alias doc) @@ -168,11 +173,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/beets.md)) (target beets.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=beets --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=beets --template=template.html -o %{target})))) (rule (alias doc) @@ -188,11 +194,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/blank.md)) (target blank.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=blank --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=blank --template=template.html -o %{target})))) (rule (alias doc) @@ -208,11 +215,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/book.md)) (target book.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=book --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=book --template=template.html -o %{target})))) (rule (alias doc) @@ -228,11 +236,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/build.md)) (target build.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=build --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=build --template=template.html -o %{target})))) (rule (alias doc) @@ -248,11 +257,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/clocks.md)) (target clocks.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=clocks --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=clocks --template=template.html -o %{target})))) (rule (alias doc) @@ -268,11 +278,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/complete_case.md)) (target complete_case.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=complete_case --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=complete_case --template=template.html -o %{target})))) (rule (alias doc) @@ -288,11 +299,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/cookbook.md)) (target cookbook.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=cookbook --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=cookbook --template=template.html -o %{target})))) (rule (alias doc) @@ -308,11 +320,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/crossfade.md)) (target crossfade.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=crossfade --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=crossfade --template=template.html -o %{target})))) (rule (alias doc) @@ -328,11 +341,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/custom-path.md)) (target custom-path.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=custom-path --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=custom-path --template=template.html -o %{target})))) (rule (alias doc) @@ -348,11 +362,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/documentation.md)) (target documentation.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=documentation --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=documentation --template=template.html -o %{target})))) (rule (alias doc) @@ -368,11 +383,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/dynamic_sources.md)) (target dynamic_sources.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=dynamic_sources --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=dynamic_sources --template=template.html -o %{target})))) (rule (alias doc) @@ -388,11 +404,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/encoding_formats.md)) (target encoding_formats.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=encoding_formats --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=encoding_formats --template=template.html -o %{target})))) (rule (alias doc) @@ -408,11 +425,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/external_decoders.md)) (target external_decoders.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=external_decoders --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=external_decoders --template=template.html -o %{target})))) (rule (alias doc) @@ -428,11 +446,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/external_encoders.md)) (target external_encoders.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=external_encoders --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=external_encoders --template=template.html -o %{target})))) (rule (alias doc) @@ -448,11 +467,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/external_streams.md)) (target external_streams.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=external_streams --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=external_streams --template=template.html -o %{target})))) (rule (alias doc) @@ -468,11 +488,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/faq.md)) (target faq.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=faq --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=faq --template=template.html -o %{target})))) (rule (alias doc) @@ -488,11 +509,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/ffmpeg.md)) (target ffmpeg.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ffmpeg --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ffmpeg --template=template.html -o %{target})))) (rule (alias doc) @@ -508,11 +530,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/ffmpeg_cookbook.md)) (target ffmpeg_cookbook.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ffmpeg_cookbook --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ffmpeg_cookbook --template=template.html -o %{target})))) (rule (alias doc) @@ -528,11 +551,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/ffmpeg_encoder.md)) (target ffmpeg_encoder.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ffmpeg_encoder --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ffmpeg_encoder --template=template.html -o %{target})))) (rule (alias doc) @@ -548,11 +572,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/ffmpeg_filters.md)) (target ffmpeg_filters.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ffmpeg_filters --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ffmpeg_filters --template=template.html -o %{target})))) (rule (alias doc) @@ -568,11 +593,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/flows_devel.md)) (target flows_devel.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=flows_devel --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=flows_devel --template=template.html -o %{target})))) (rule (alias doc) @@ -588,11 +614,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/frequence3.md)) (target frequence3.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=frequence3 --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=frequence3 --template=template.html -o %{target})))) (rule (alias doc) @@ -608,11 +635,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/geekradio.md)) (target geekradio.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=geekradio --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=geekradio --template=template.html -o %{target})))) (rule (alias doc) @@ -628,11 +656,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/gstreamer_encoder.md)) (target gstreamer_encoder.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=gstreamer_encoder --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=gstreamer_encoder --template=template.html -o %{target})))) (rule (alias doc) @@ -648,11 +677,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/harbor.md)) (target harbor.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=harbor --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=harbor --template=template.html -o %{target})))) (rule (alias doc) @@ -668,11 +698,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/harbor_http.md)) (target harbor_http.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=harbor_http --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=harbor_http --template=template.html -o %{target})))) (rule (alias doc) @@ -688,11 +719,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/help.md)) (target help.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=help --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=help --template=template.html -o %{target})))) (rule (alias doc) @@ -708,11 +740,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/hls_output.md)) (target hls_output.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=hls_output --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=hls_output --template=template.html -o %{target})))) (rule (alias doc) @@ -728,11 +761,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/http_input.md)) (target http_input.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=http_input --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=http_input --template=template.html -o %{target})))) (rule (alias doc) @@ -748,11 +782,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/icy_metadata.md)) (target icy_metadata.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=icy_metadata --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=icy_metadata --template=template.html -o %{target})))) (rule (alias doc) @@ -768,11 +803,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/in_production.md)) (target in_production.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=in_production --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=in_production --template=template.html -o %{target})))) (rule (alias doc) @@ -788,11 +824,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/index.md)) (target index.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=index --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=index --template=template.html -o %{target})))) (rule (alias doc) @@ -808,11 +845,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/install.md)) (target install.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=install --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=install --template=template.html -o %{target})))) (rule (alias doc) @@ -828,11 +866,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/json.md)) (target json.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=json --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=json --template=template.html -o %{target})))) (rule (alias doc) @@ -848,11 +887,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/ladspa.md)) (target ladspa.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ladspa --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=ladspa --template=template.html -o %{target})))) (rule (alias doc) @@ -868,11 +908,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/language.md)) (target language.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=language --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=language --template=template.html -o %{target})))) (rule (alias doc) @@ -888,11 +929,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/memory.md)) (target memory.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=memory --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=memory --template=template.html -o %{target})))) (rule (alias doc) @@ -908,11 +950,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/metadata.md)) (target metadata.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=metadata --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=metadata --template=template.html -o %{target})))) (rule (alias doc) @@ -928,11 +971,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/migrating.md)) (target migrating.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=migrating --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=migrating --template=template.html -o %{target})))) (rule (alias doc) @@ -948,11 +992,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/multitrack.md)) (target multitrack.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=multitrack --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=multitrack --template=template.html -o %{target})))) (rule (alias doc) @@ -968,11 +1013,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/on2.md)) (target on2.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=on2 --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=on2 --template=template.html -o %{target})))) (rule (alias doc) @@ -988,11 +1034,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/on2_part1.md)) (target on2_part1.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=on2_part1 --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=on2_part1 --template=template.html -o %{target})))) (rule (alias doc) @@ -1008,11 +1055,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/on2_part2.md)) (target on2_part2.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=on2_part2 --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=on2_part2 --template=template.html -o %{target})))) (rule (alias doc) @@ -1028,11 +1076,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/on2_part3.md)) (target on2_part3.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=on2_part3 --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=on2_part3 --template=template.html -o %{target})))) (rule (alias doc) @@ -1048,11 +1097,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/phases.md)) (target phases.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=phases --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=phases --template=template.html -o %{target})))) (rule (alias doc) @@ -1068,11 +1118,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/playlist_parsers.md)) (target playlist_parsers.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=playlist_parsers --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=playlist_parsers --template=template.html -o %{target})))) (rule (alias doc) @@ -1088,11 +1139,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/presentations.md)) (target presentations.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=presentations --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=presentations --template=template.html -o %{target})))) (rule (alias doc) @@ -1108,11 +1160,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/profiling.md)) (target profiling.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=profiling --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=profiling --template=template.html -o %{target})))) (rule (alias doc) @@ -1128,11 +1181,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/prometheus.md)) (target prometheus.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=prometheus --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=prometheus --template=template.html -o %{target})))) (rule (alias doc) @@ -1148,11 +1202,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/protocols-presentation.md)) (target protocols-presentation.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=protocols-presentation --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=protocols-presentation --template=template.html -o %{target})))) (rule (alias doc) @@ -1168,11 +1223,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/publications.md)) (target publications.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=publications --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=publications --template=template.html -o %{target})))) (rule (alias doc) @@ -1188,11 +1244,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/quick_start.md)) (target quick_start.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=quick_start --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=quick_start --template=template.html -o %{target})))) (rule (alias doc) @@ -1208,11 +1265,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/radiopi.md)) (target radiopi.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=radiopi --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=radiopi --template=template.html -o %{target})))) (rule (alias doc) @@ -1228,11 +1286,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/reference-header.md)) (target reference-header.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=reference-header --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=reference-header --template=template.html -o %{target})))) (rule (alias doc) @@ -1248,11 +1307,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/release-assets.md)) (target release-assets.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=release-assets --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=release-assets --template=template.html -o %{target})))) (rule (alias doc) @@ -1268,11 +1328,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/replay_gain.md)) (target replay_gain.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=replay_gain --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=replay_gain --template=template.html -o %{target})))) (rule (alias doc) @@ -1288,11 +1349,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/request_sources.md)) (target request_sources.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=request_sources --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=request_sources --template=template.html -o %{target})))) (rule (alias doc) @@ -1308,11 +1370,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/requests.md)) (target requests.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=requests --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=requests --template=template.html -o %{target})))) (rule (alias doc) @@ -1328,11 +1391,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/rolling-release.md)) (target rolling-release.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=rolling-release --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=rolling-release --template=template.html -o %{target})))) (rule (alias doc) @@ -1348,11 +1412,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/script_loading.md)) (target script_loading.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=script_loading --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=script_loading --template=template.html -o %{target})))) (rule (alias doc) @@ -1368,11 +1433,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/seek.md)) (target seek.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=seek --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=seek --template=template.html -o %{target})))) (rule (alias doc) @@ -1388,11 +1454,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/server.md)) (target server.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=server --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=server --template=template.html -o %{target})))) (rule (alias doc) @@ -1408,11 +1475,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/shoutcast.md)) (target shoutcast.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=shoutcast --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=shoutcast --template=template.html -o %{target})))) (rule (alias doc) @@ -1428,11 +1496,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/sources.md)) (target sources.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=sources --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=sources --template=template.html -o %{target})))) (rule (alias doc) @@ -1448,11 +1517,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/split-cue.md)) (target split-cue.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=split-cue --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=split-cue --template=template.html -o %{target})))) (rule (alias doc) @@ -1468,11 +1538,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/stereotool.md)) (target stereotool.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=stereotool --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=stereotool --template=template.html -o %{target})))) (rule (alias doc) @@ -1488,11 +1559,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/stream_content.md)) (target stream_content.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=stream_content --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=stream_content --template=template.html -o %{target})))) (rule (alias doc) @@ -1508,11 +1580,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/strings_encoding.md)) (target strings_encoding.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=strings_encoding --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=strings_encoding --template=template.html -o %{target})))) (rule (alias doc) @@ -1528,11 +1601,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/video-static.md)) (target video-static.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=video-static --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=video-static --template=template.html -o %{target})))) (rule (alias doc) @@ -1548,11 +1622,12 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/video.md)) (target video.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=video --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=video --template=template.html -o %{target})))) (rule (alias doc) @@ -1568,110 +1643,113 @@ liquidsoap.xml language.dtd template.html + content/liq/space_overhead.liq (:md content/yaml.md)) (target yaml.html) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=yaml --template=template.html -o %{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %{md} --metadata pagetitle=yaml --template=template.html -o %{target})))) (install - (section doc) - (package liquidsoap) - (files + (section doc) + (package liquidsoap) + (files + (beets.html as html/beets.html) + (blank.html as html/blank.html) + (book.html as html/book.html) + (build.html as html/build.html) + (clocks.html as html/clocks.html) + (complete_case.html as html/complete_case.html) + (cookbook.html as html/cookbook.html) + (crossfade.html as html/crossfade.html) + (custom-path.html as html/custom-path.html) + (documentation.html as html/documentation.html) + (dynamic_sources.html as html/dynamic_sources.html) + (encoding_formats.html as html/encoding_formats.html) + (external_decoders.html as html/external_decoders.html) + (external_encoders.html as html/external_encoders.html) + (external_streams.html as html/external_streams.html) + (faq.html as html/faq.html) + (ffmpeg.html as html/ffmpeg.html) + (ffmpeg_cookbook.html as html/ffmpeg_cookbook.html) + (ffmpeg_encoder.html as html/ffmpeg_encoder.html) + (ffmpeg_filters.html as html/ffmpeg_filters.html) + (flows_devel.html as html/flows_devel.html) + (frequence3.html as html/frequence3.html) + (geekradio.html as html/geekradio.html) + (gstreamer_encoder.html as html/gstreamer_encoder.html) + (harbor.html as html/harbor.html) + (harbor_http.html as html/harbor_http.html) + (help.html as html/help.html) + (hls_output.html as html/hls_output.html) + (http_input.html as html/http_input.html) + (icy_metadata.html as html/icy_metadata.html) + (in_production.html as html/in_production.html) + (index.html as html/index.html) + (install.html as html/install.html) + (json.html as html/json.html) + (ladspa.html as html/ladspa.html) + (language.html as html/language.html) + (memory.html as html/memory.html) + (metadata.html as html/metadata.html) + (migrating.html as html/migrating.html) + (multitrack.html as html/multitrack.html) + (on2.html as html/on2.html) + (on2_part1.html as html/on2_part1.html) + (on2_part2.html as html/on2_part2.html) + (on2_part3.html as html/on2_part3.html) + (orig/css/homepage.css as html/css/homepage.css) + (orig/css/style.css as html/css/style.css) + (orig/fosdem2020/clock.png as html/fosdem2020/clock.png) + (orig/fosdem2020/index.html as html/fosdem2020/index.html) + (orig/fosdem2020/logo.png as html/fosdem2020/logo.png) + (orig/fosdem2020/radio.gif as html/fosdem2020/radio.gif) + (orig/fosdem2020/remark.js as html/fosdem2020/remark.js) + (orig/images/basic-radio-graph.png as html/images/basic-radio-graph.png) + (orig/images/design/background.png as html/images/design/background.png) + (orig/images/design/background_page.png as html/images/design/background_page.png) + (orig/images/design/logo.png as html/images/design/logo.png) + (orig/images/grab.png as html/images/grab.png) + (orig/images/graph_clocks.png as html/images/graph_clocks.png) + (orig/images/liqgraph.png as html/images/liqgraph.png) + (orig/images/schema-webradio-inkscape.png as html/images/schema-webradio-inkscape.png) + (orig/images/stream.png as html/images/stream.png) + (orig/images/tabs/tab_API.png as html/images/tabs/tab_API.png) + (orig/images/tabs/tab_about.png as html/images/tabs/tab_about.png) + (orig/images/tabs/tab_developers.png as html/images/tabs/tab_developers.png) + (orig/images/tabs/tab_docs.png as html/images/tabs/tab_docs.png) (orig/images/tabs/tab_snippets.png as html/images/tabs/tab_snippets.png) -(orig/images/tabs/tab_docs.png as html/images/tabs/tab_docs.png) -(orig/images/tabs/tab_developers.png as html/images/tabs/tab_developers.png) -(orig/images/tabs/tab_about.png as html/images/tabs/tab_about.png) -(orig/images/tabs/tab_API.png as html/images/tabs/tab_API.png) -(orig/images/stream.png as html/images/stream.png) -(orig/images/schema-webradio-inkscape.png as html/images/schema-webradio-inkscape.png) -(orig/images/liqgraph.png as html/images/liqgraph.png) -(orig/images/graph_clocks.png as html/images/graph_clocks.png) -(orig/images/grab.png as html/images/grab.png) -(orig/images/design/logo.png as html/images/design/logo.png) -(orig/images/design/background_page.png as html/images/design/background_page.png) -(orig/images/design/background.png as html/images/design/background.png) -(orig/images/basic-radio-graph.png as html/images/basic-radio-graph.png) -(orig/fosdem2020/remark.js as html/fosdem2020/remark.js) -(orig/fosdem2020/radio.gif as html/fosdem2020/radio.gif) -(orig/fosdem2020/logo.png as html/fosdem2020/logo.png) -(orig/fosdem2020/index.html as html/fosdem2020/index.html) -(orig/fosdem2020/clock.png as html/fosdem2020/clock.png) -(orig/css/style.css as html/css/style.css) -(orig/css/homepage.css as html/css/homepage.css) + (phases.html as html/phases.html) + (playlist_parsers.html as html/playlist_parsers.html) + (presentations.html as html/presentations.html) + (profiling.html as html/profiling.html) + (prometheus.html as html/prometheus.html) + (protocols-presentation.html as html/protocols-presentation.html) (protocols.html as html/protocols.html) -(reference.html as html/reference.html) -(reference-extras.html as html/reference-extras.html) -(reference-deprecated.html as html/reference-deprecated.html) -(settings.html as html/settings.html) - (beets.html as html/beets.html) -(blank.html as html/blank.html) -(book.html as html/book.html) -(build.html as html/build.html) -(clocks.html as html/clocks.html) -(complete_case.html as html/complete_case.html) -(cookbook.html as html/cookbook.html) -(crossfade.html as html/crossfade.html) -(custom-path.html as html/custom-path.html) -(documentation.html as html/documentation.html) -(dynamic_sources.html as html/dynamic_sources.html) -(encoding_formats.html as html/encoding_formats.html) -(external_decoders.html as html/external_decoders.html) -(external_encoders.html as html/external_encoders.html) -(external_streams.html as html/external_streams.html) -(faq.html as html/faq.html) -(ffmpeg.html as html/ffmpeg.html) -(ffmpeg_cookbook.html as html/ffmpeg_cookbook.html) -(ffmpeg_encoder.html as html/ffmpeg_encoder.html) -(ffmpeg_filters.html as html/ffmpeg_filters.html) -(flows_devel.html as html/flows_devel.html) -(frequence3.html as html/frequence3.html) -(geekradio.html as html/geekradio.html) -(gstreamer_encoder.html as html/gstreamer_encoder.html) -(harbor.html as html/harbor.html) -(harbor_http.html as html/harbor_http.html) -(help.html as html/help.html) -(hls_output.html as html/hls_output.html) -(http_input.html as html/http_input.html) -(icy_metadata.html as html/icy_metadata.html) -(in_production.html as html/in_production.html) -(index.html as html/index.html) -(install.html as html/install.html) -(json.html as html/json.html) -(ladspa.html as html/ladspa.html) -(language.html as html/language.html) -(memory.html as html/memory.html) -(metadata.html as html/metadata.html) -(migrating.html as html/migrating.html) -(multitrack.html as html/multitrack.html) -(on2.html as html/on2.html) -(on2_part1.html as html/on2_part1.html) -(on2_part2.html as html/on2_part2.html) -(on2_part3.html as html/on2_part3.html) -(phases.html as html/phases.html) -(playlist_parsers.html as html/playlist_parsers.html) -(presentations.html as html/presentations.html) -(profiling.html as html/profiling.html) -(prometheus.html as html/prometheus.html) -(protocols-presentation.html as html/protocols-presentation.html) -(publications.html as html/publications.html) -(quick_start.html as html/quick_start.html) -(radiopi.html as html/radiopi.html) -(reference-header.html as html/reference-header.html) -(release-assets.html as html/release-assets.html) -(replay_gain.html as html/replay_gain.html) -(request_sources.html as html/request_sources.html) -(requests.html as html/requests.html) -(rolling-release.html as html/rolling-release.html) -(script_loading.html as html/script_loading.html) -(seek.html as html/seek.html) -(server.html as html/server.html) -(shoutcast.html as html/shoutcast.html) -(sources.html as html/sources.html) -(split-cue.html as html/split-cue.html) -(stereotool.html as html/stereotool.html) -(stream_content.html as html/stream_content.html) -(strings_encoding.html as html/strings_encoding.html) -(video-static.html as html/video-static.html) -(video.html as html/video.html) -(yaml.html as html/yaml.html))) + (publications.html as html/publications.html) + (quick_start.html as html/quick_start.html) + (radiopi.html as html/radiopi.html) + (reference-deprecated.html as html/reference-deprecated.html) + (reference-extras.html as html/reference-extras.html) + (reference-header.html as html/reference-header.html) + (reference.html as html/reference.html) + (release-assets.html as html/release-assets.html) + (replay_gain.html as html/replay_gain.html) + (request_sources.html as html/request_sources.html) + (requests.html as html/requests.html) + (rolling-release.html as html/rolling-release.html) + (script_loading.html as html/script_loading.html) + (seek.html as html/seek.html) + (server.html as html/server.html) + (settings.html as html/settings.html) + (shoutcast.html as html/shoutcast.html) + (sources.html as html/sources.html) + (split-cue.html as html/split-cue.html) + (stereotool.html as html/stereotool.html) + (stream_content.html as html/stream_content.html) + (strings_encoding.html as html/strings_encoding.html) + (video-static.html as html/video-static.html) + (video.html as html/video.html) + (yaml.html as html/yaml.html) + ) +) diff --git a/doc/gen_dune.ml b/doc/gen_dune.ml index cf55f311f8..3da58b7cef 100644 --- a/doc/gen_dune.ml +++ b/doc/gen_dune.ml @@ -37,7 +37,8 @@ let mk_subst_rule f = (run %%{subst_md} %%{in_md}))))|} f target) -let mk_html_rule ~content f = +let mk_html_rule ~liq ~content f = + let liq = liq |> List.map (fun f -> " " ^ f) |> String.concat "\n" in Printf.printf {| (rule @@ -54,13 +55,14 @@ let mk_html_rule ~content f = liquidsoap.xml language.dtd template.html +%s (:md %s)) (target %s) (action (ignore-outputs - (run pandoc --syntax-definition=liquidsoap.xml --highlight=pygments %%{md} --metadata pagetitle=%s --template=template.html -o %%{target})))) + (run pandoc --filter=pandoc-include --syntax-definition=liquidsoap.xml --highlight=pygments %%{md} --metadata pagetitle=%s --template=template.html -o %%{target})))) |} - (mk_html f) (mk_md ~content f) (mk_html f) (mk_title f) + (mk_html f) liq (mk_md ~content f) (mk_html f) (mk_title f) let mk_generated_rule (file, option, header) = let header_deps, header_action, header_close = @@ -87,7 +89,7 @@ let mk_generated_rule (file, option, header) = header_deps file file header_action option header_close let mk_html_install f = - Printf.sprintf {|(%s as html/%s)|} (mk_html f) (mk_html f) + Printf.sprintf {| (%s as html/%s)|} (mk_html f) (mk_html f) let rec readdir ?(cur = []) ~location dir = List.fold_left @@ -102,29 +104,41 @@ let rec readdir ?(cur = []) ~location dir = let () = let location = Filename.dirname Sys.executable_name in let md = - List.sort compare - (List.filter - (fun f -> Filename.extension f = ".md" || Filename.extension f = ".in") - (Array.to_list (Sys.readdir (Filename.concat location "content")))) + Sys.readdir (Filename.concat location "content") + |> Array.to_list + |> List.filter (fun f -> + Filename.extension f = ".md" || Filename.extension f = ".in") + |> List.sort compare + in + let liq = + Sys.readdir (Filename.concat location "content/liq") + |> Array.to_list + |> List.filter (fun f -> Filename.extension f = ".liq") + |> List.sort compare + |> List.map (fun f -> "content/liq/" ^ f) in List.iter mk_generated_rule generated_md; List.iter mk_subst_rule md; - List.iter (fun (file, _, _) -> mk_html_rule ~content:false file) generated_md; - List.iter (mk_html_rule ~content:true) md; + List.iter + (fun (file, _, _) -> mk_html_rule ~liq ~content:false file) + generated_md; + List.iter (mk_html_rule ~liq ~content:true) md; + let files = + List.map + (fun f -> Printf.sprintf {| (orig/%s as html/%s)|} f f) + (readdir ~location:(Filename.concat location "orig") "") + @ List.map (fun (f, _, _) -> mk_html_install f) generated_md + @ List.map mk_html_install md + in + let files = files |> List.sort compare |> String.concat "\n" in Printf.printf {| (install - (section doc) - (package liquidsoap) - (files - %s - %s - %s)) + (section doc) + (package liquidsoap) + (files +%s + ) +) |} - (String.concat "\n" - (List.map - (fun f -> Printf.sprintf {|(orig/%s as html/%s)|} f f) - (readdir ~location:(Filename.concat location "orig") ""))) - (String.concat "\n" - (List.map (fun (f, _, _) -> mk_html_install f) generated_md)) - (String.concat "\n" (List.map mk_html_install md)) + files diff --git a/doc/no-pandoc b/doc/no-pandoc index 0e43453094..545a21fe2f 100644 --- a/doc/no-pandoc +++ b/doc/no-pandoc @@ -1 +1 @@ -Please rebuild with pandoc installed to generate liquidsoap documentation.. +Please rebuild with pandoc installed to generate liquidsoap documentation.