From 2ec9e00bcc87c3c3a3de0887a348421ba3ddfb39 Mon Sep 17 00:00:00 2001 From: PatPgt <115630169+pat-pgt@users.noreply.github.com> Date: Wed, 18 Sep 2024 15:54:51 +0200 Subject: [PATCH] First work-flow for the documentation --- .github/workflows/graphviz.yml | 35 ++++++++++++++++++++++++++++++++++ Documentation/Makefile | 11 +++++++++++ 2 files changed, 46 insertions(+) create mode 100644 .github/workflows/graphviz.yml create mode 100644 Documentation/Makefile diff --git a/.github/workflows/graphviz.yml b/.github/workflows/graphviz.yml new file mode 100644 index 0000000..6b6025f --- /dev/null +++ b/.github/workflows/graphviz.yml @@ -0,0 +1,35 @@ +name: Graphviz documentation CI + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + workflow_dispatch: + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: environement + run: sudo apt-get install -y graphviz + - name: setup folders + run: | + mkdir build + mkdir build/pdf + mkdir build/jpeg + mkdir build/png + - name: building + run: | + cd Documentation + make DOTLANG=pdf BUILDDIR=../build/pdf/ + make DOTLANG=jpeg BUILDDIR=../build/jpeg/ + make DOTLANG=png BUILDDIR=../build/png/ + - name: return workflow as artifacts + uses: actions/upload-artifact@v4 + with: + name: MultiFrequenciesDetector-doc + path: build/* diff --git a/Documentation/Makefile b/Documentation/Makefile new file mode 100644 index 0000000..3b569a4 --- /dev/null +++ b/Documentation/Makefile @@ -0,0 +1,11 @@ +DOT?=dot +DOTLANG?=pdf +DOTFLAGS?= +SRCDIR?= +BUILDDIR?= + +doc : + $(DOT) $(DOTFLAGS) -T$(DOTLANG) $(SRCDIR)Overview.gv -o $(BUILDDIR)Overview.$(DOTLANG) + +clean : + rm -f $(BUILDDIR)Overview.$(DOTLANG)