diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..8205718 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,37 @@ +# Builds and publishes the documentation website to gh-pages branch +name: Build docs + +on: + workflow_dispatch: + push: + tags: + - "v[0-9]+.[0-9]+.[0-9]+" + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + # Build static site content using DocFX + - uses: nikeee/docfx-action@v1.0.0 + name: Build Documentation + with: + args: Docs/docfx.json + + - name: Checkout gh-pages + uses: actions/checkout@v2 + with: + ref: gh-pages + path: gh-pages + - name: Publish to github pages + run: | + cd gh-pages + rm -rf * + touch .nojekyll + cp -a ../Docs/_site/. . + git config user.name github-actions + git config user.email github-actions@github.com + git add . + git commit --reset-author --amend -m "Deploy docs website" + git push --force origin gh-pages diff --git a/Docs/.gitignore b/Docs/.gitignore new file mode 100644 index 0000000..c08f9ad --- /dev/null +++ b/Docs/.gitignore @@ -0,0 +1 @@ +_site \ No newline at end of file diff --git a/Docs/api/.gitignore b/Docs/api/.gitignore new file mode 100644 index 0000000..e8079a3 --- /dev/null +++ b/Docs/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/Docs/articles/intro.md b/Docs/articles/intro.md new file mode 100644 index 0000000..fa5efdc --- /dev/null +++ b/Docs/articles/intro.md @@ -0,0 +1,5 @@ +Getting Started +=============== + +1. Download [Bonsai](https://bonsai-rx.org/). +2. From the package manager, search and install the **Emotional Cities - Pluma** package. diff --git a/Docs/articles/toc.yml b/Docs/articles/toc.yml new file mode 100644 index 0000000..ff89ef1 --- /dev/null +++ b/Docs/articles/toc.yml @@ -0,0 +1,2 @@ +- name: Introduction + href: intro.md diff --git a/Docs/docfx.json b/Docs/docfx.json new file mode 100644 index 0000000..7d0d9e2 --- /dev/null +++ b/Docs/docfx.json @@ -0,0 +1,73 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "EmotionalCities.Pluma/*.csproj" + ], + "src": "../Interface" + } + ], + "dest": "api", + "disableGitFeatures": false, + "disableDefaultFilter": false + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml", + "api/index.md" + ] + }, + { + "files": [ + "articles/**.md", + "articles/**/toc.yml", + "toc.yml", + "*.md" + ] + } + ], + "resource": [ + { + "files": [ + "logo.svg", + "favicon.ico", + "images/**" + ] + } + ], + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ + "default", + "templates/html" + ], + "postProcessors": [ "ExtractSearchIndex" ], + "markdownEngineName": "markdig", + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": false, + "xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ], + "xref": [ + "https://bonsai-rx.org/docs/xrefmap.yml", + "https://harp-tech.org/docs/xrefmap.yml" + ] + } +} \ No newline at end of file diff --git a/Docs/favicon.ico b/Docs/favicon.ico new file mode 100644 index 0000000..5f9121a Binary files /dev/null and b/Docs/favicon.ico differ diff --git a/Docs/index.md b/Docs/index.md new file mode 100644 index 0000000..25fad22 --- /dev/null +++ b/Docs/index.md @@ -0,0 +1,8 @@ +# **Emotional Cities - Pluma** Documentation + +Bonsai Library for interfacing with the eMOTIONAL Cities wearable data acquisition board. + +> [!Warning] +> These docs are under active development, feel free to contribute by either [raising an issue](https://github.com/emotional-cities/pluma/issues) or following the links to **Improve this Doc**. + +This package was developed for the eMOTIONAL CITIES Project, which received funding from European Union’s Horizon 2020 research and innovation programme, under the grant agreement No 945307. The eMOTIONAL CITIES Project is a consortium of 12 partners co-coordinated by IGOT and FMUL, taking place between 2021 and 2025. More information at https://emotionalcities-h2020.eu/ diff --git a/Docs/logo.svg b/Docs/logo.svg new file mode 100644 index 0000000..2dbe666 --- /dev/null +++ b/Docs/logo.svg @@ -0,0 +1,362 @@ + + + + + + + + + + + + + + diff --git a/Docs/templates/html/styles/main.css b/Docs/templates/html/styles/main.css new file mode 100644 index 0000000..4d9bb48 --- /dev/null +++ b/Docs/templates/html/styles/main.css @@ -0,0 +1,19 @@ +.affix { + height: auto; +} + +.sideaffix { + overflow-x: hidden; + overflow-y: auto; +} + +.affix > ul.level1 { + overflow: inherit; +} + +.affix ul > li.active > ul, +.affix ul > li.active > a:before, +.affix ul > li > a:hover:before { + display: block; + white-space: inherit; +} \ No newline at end of file diff --git a/Docs/toc.yml b/Docs/toc.yml new file mode 100644 index 0000000..e61b382 --- /dev/null +++ b/Docs/toc.yml @@ -0,0 +1,4 @@ +- name: Manual + href: articles/ +- name: Reference + href: api/