Merge pull request #146 from Simple-Robotics/topic/add-gh-pages

[github/workflows] Add gh-pages workflow

Author: ManifoldFR

.github/workflows/gh-pages.yml

@@ -0,0 +1,78 @@
+name: gh-pages
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-variant: Mambaforge
+          miniforge-version: latest
+          channels: conda-forge
+          python-version: "3.10"
+          activate-environment: doc
+
+      - name: Dependencies
+        shell: bash -l {0}
+        run: |
+          # Workaround for https://github.com/conda-incubator/setup-miniconda/issues/186
+          conda config --remove channels defaults
+
+          # Compilation related dependencies
+          mamba install cmake make pkg-config doxygen graphviz
+
+          # Main dependencies
+          mamba install eigen pinocchio fmt proxsuite-nlp
+
+      - name: Print environment
+        shell: bash -l {0}
+        run: |
+          conda info
+          mamba list
+          env
+
+      - name: Configure
+        shell: bash -l {0}
+        run: |
+          git submodule update --init
+          mkdir build
+          cd build
+          cmake .. -DCMAKE_INSTALL_PREFIX=${CONDA_PREFIX} -DCMAKE_BUILD_TYPE=Release -DBUILD_PYTHON_INTERFACE:BOOL=OFF\
+            -DPYTHON_EXECUTABLE=$(which python3) -DBUILD_DOCUMENTATION:BOOL=ON \
+            -DBUILD_BENCHMARKS:BOOL=OFF -DINSTALL_DOCUMENTATION:BOOL=ON -DBUILD_TESTING:BOOL=OFF \
+            -DBUILD_CROCODDYL_COMPAT:BOOL=OFF
+
+      - name: Build documentation
+        shell: bash -l {0}
+        run: |
+          cd build
+          cmake --build . --config Release --target doc
+
+      - name: Archive artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: site
+          path: build/doc/doxygen-html
+
+  deploy:
+    runs-on: ubuntu-20.04
+    needs: [build]
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: site
+          path: site
+      - name: Deploy
+        uses: JamesIves/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: site

README.md

@@ -1,5 +1,7 @@
 # Aligator
 
+<a href="https://simple-robotics.github.io/aligator/"><img src="https://img.shields.io/badge/docs-online-brightgreen" alt="Documentation"/></a>
+
 **Aligator** is an efficient and versatile trajectory optimization library for robotics and beyond.
 
 It can be used for motion generation and planning, optimal estimation, deployment of model-predictive control on complex systems, and much more.