From 93449753d116244fefdec3c9f7b72479cf05a799 Mon Sep 17 00:00:00 2001 From: Charles Madjeri Date: Tue, 26 Nov 2024 14:55:43 +0100 Subject: [PATCH] feat(workflows): deploy documentation Signed-off-by: Charles Madjeri --- .github/workflows/deploy-documentation.yml | 27 +++++++++++++++++++ .gitignore | 1 + {doc => docs}/Makefile | 0 {doc => docs}/source/Project/benchmark.rst | 0 {doc => docs}/source/Project/index.rst | 0 {doc => docs}/source/client_mobile/index.rst | 0 .../source/client_mobile/installation.rst | 0 {doc => docs}/source/client_web/context.rst | 0 {doc => docs}/source/client_web/index.rst | 0 .../source/client_web/installation.rst | 0 {doc => docs}/source/conf.py | 0 {doc => docs}/source/contributing.rst | 0 {doc => docs}/source/index.rst | 0 {doc => docs}/source/server/index.rst | 0 {doc => docs}/source/server/installation.rst | 0 15 files changed, 28 insertions(+) create mode 100644 .github/workflows/deploy-documentation.yml rename {doc => docs}/Makefile (100%) rename {doc => docs}/source/Project/benchmark.rst (100%) rename {doc => docs}/source/Project/index.rst (100%) rename {doc => docs}/source/client_mobile/index.rst (100%) rename {doc => docs}/source/client_mobile/installation.rst (100%) rename {doc => docs}/source/client_web/context.rst (100%) rename {doc => docs}/source/client_web/index.rst (100%) rename {doc => docs}/source/client_web/installation.rst (100%) rename {doc => docs}/source/conf.py (100%) rename {doc => docs}/source/contributing.rst (100%) rename {doc => docs}/source/index.rst (100%) rename {doc => docs}/source/server/index.rst (100%) rename {doc => docs}/source/server/installation.rst (100%) diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml new file mode 100644 index 0000000..95da6dc --- /dev/null +++ b/.github/workflows/deploy-documentation.yml @@ -0,0 +1,27 @@ +name: deploy-documentation + +on: [push, pull_request, workflow_dispatch] + +permissions: + contents: write + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + - name: Install dependencies + run: | + pip install sphinx sphinx_rtd_theme myst_parser + - name: Sphinx build + run: | + sphinx-build docs/source docs/_build + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/cma/feat-deploy-documentation' }} + with: + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: _build/ + force_orphan: true \ No newline at end of file diff --git a/.gitignore b/.gitignore index ac228f0..d2a6fa5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ # IDE .idea/ +.vscode/ # Documentation build/ diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/source/Project/benchmark.rst b/docs/source/Project/benchmark.rst similarity index 100% rename from doc/source/Project/benchmark.rst rename to docs/source/Project/benchmark.rst diff --git a/doc/source/Project/index.rst b/docs/source/Project/index.rst similarity index 100% rename from doc/source/Project/index.rst rename to docs/source/Project/index.rst diff --git a/doc/source/client_mobile/index.rst b/docs/source/client_mobile/index.rst similarity index 100% rename from doc/source/client_mobile/index.rst rename to docs/source/client_mobile/index.rst diff --git a/doc/source/client_mobile/installation.rst b/docs/source/client_mobile/installation.rst similarity index 100% rename from doc/source/client_mobile/installation.rst rename to docs/source/client_mobile/installation.rst diff --git a/doc/source/client_web/context.rst b/docs/source/client_web/context.rst similarity index 100% rename from doc/source/client_web/context.rst rename to docs/source/client_web/context.rst diff --git a/doc/source/client_web/index.rst b/docs/source/client_web/index.rst similarity index 100% rename from doc/source/client_web/index.rst rename to docs/source/client_web/index.rst diff --git a/doc/source/client_web/installation.rst b/docs/source/client_web/installation.rst similarity index 100% rename from doc/source/client_web/installation.rst rename to docs/source/client_web/installation.rst diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to docs/source/conf.py diff --git a/doc/source/contributing.rst b/docs/source/contributing.rst similarity index 100% rename from doc/source/contributing.rst rename to docs/source/contributing.rst diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst diff --git a/doc/source/server/index.rst b/docs/source/server/index.rst similarity index 100% rename from doc/source/server/index.rst rename to docs/source/server/index.rst diff --git a/doc/source/server/installation.rst b/docs/source/server/installation.rst similarity index 100% rename from doc/source/server/installation.rst rename to docs/source/server/installation.rst