From 367496ab8cfd70bd006f50b4da2ddee8232d7647 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Astor?= Date: Wed, 23 Mar 2022 08:28:59 +0100 Subject: [PATCH] try to get plugins doc --- .github/workflows/build.yml | 4 ++++ docs/Reference/Plugins/README.mdr | 3 +++ scripts/mk_page.sh | 18 ++++++++++++++++++ scripts/update.sh | 1 + 4 files changed, 26 insertions(+) create mode 100644 docs/Reference/Plugins/README.mdr create mode 100644 scripts/mk_page.sh diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca2fb02b..b7d6194c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -39,6 +39,10 @@ jobs: ./gwion --cdoc >> docs/Reference/README.mdr echo '```' >> docs/Reference/README.mdr + - name: Plugin Reference + run: | + for plug in *.so; do bash scripts/mk_page.sh $plug; done + - name: Build book run: PATH=$PWD:$PATH make build diff --git a/docs/Reference/Plugins/README.mdr b/docs/Reference/Plugins/README.mdr new file mode 100644 index 00000000..d700cba5 --- /dev/null +++ b/docs/Reference/Plugins/README.mdr @@ -0,0 +1,3 @@ +# Plugin Reference + +compiler generated docs for gwion plugins diff --git a/scripts/mk_page.sh b/scripts/mk_page.sh new file mode 100644 index 00000000..f9b27f7b --- /dev/null +++ b/scripts/mk_page.sh @@ -0,0 +1,18 @@ +NAME=$(echo $1 | sed 's/\.so//') +DATA="./gwion -p. -P $NAME" + +mkpage() { +cat << EOF +# $NAME + +compiler generated documentation + +\`\`\`gwion +EOF + +./gwion -p. -P $NAME + +echo '```' +} + +mkpage > docs/Reference/Plugins/$NAME.mdr diff --git a/scripts/update.sh b/scripts/update.sh index 8cf9e86b..ebbba59a 100644 --- a/scripts/update.sh +++ b/scripts/update.sh @@ -15,5 +15,6 @@ update() { } update Gwion gwion +update Gwion gwion-plug update fennecdjay mdr update fennecdjay cmojify -- 2.43.0