From 2a783cd5a266d39c28ded93d15725dff17a7dfa9 Mon Sep 17 00:00:00 2001 From: Thibaut Monseigne <thibaut.monseigne@inria.fr> Date: Tue, 26 Jan 2021 10:52:28 +0100 Subject: [PATCH] :construction_worker: Add Documentation Gitlab CI --- .gitlab-ci.yml | 37 +++++++++++++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 .gitlab-ci.yml diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..3f99196 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,37 @@ +variables: + GIT_SUBMODULE_STRATEGY: recursive + DocumentationPath: _site + PagesPath: public + +stages: + - documentation + - deploy + +default: + +# Generate the documentation +documentation: + stage: documentation + variables: + LogFile: DocumentationLogs.txt + script: + # Copy and fix README.md links + - sed -r 's#/?Documentation/##gi' README.md > Documentation/index.md + # Generate documentation + - docfx metadata -f Documentation/docfx.json | tee $LogFile + - docfx build -f Documentation/docfx.json | tee -a $LogFile + artifacts: + paths: + - $DocumentationPath + - $LogFile + +# Deploy the documentation online +pages: + stage: deploy + script: cp -r $DocumentationPath $PagesPath + artifacts: + paths: + - $PagesPath + only: + - master + diff --git a/README.md b/README.md index 970c6e0..8a69d2e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # LSL4Unity -[](https://tmonseigne.github.io/LSL4Unity/) +[](https://openvibe.gitlabpages.inria.fr/unity-games/LSL4Unity/) **It's a Forks** of an integration approach of the LabStreamingLayer Framework for Unity3D providing the following features. -- GitLab