Repository: pollen-robotics/reachy2-sdk (language: python)

Issue:
publish technical documentation 



Discussion / hints:

Fix patch:
diff --git a/gitattributes_example b/.gitattributes
similarity index 97%
rename from gitattributes_example
rename to .gitattributes
index 5f198827..458d0e4d 100644
--- a/gitattributes_example
+++ b/.gitattributes
@@ -4,7 +4,7 @@
 # Image
 *.jpg lfs
 *.jpeg lfs
-*.png lfs
+#*.png lfs
 *.apng lfs
 *.atsc lfs
 *.gif lfs
@@ -39,3 +39,4 @@
 *.vis lfs
 *.db lfs
 *.ply lfs
+
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index bd0cc618..8ff4b70e 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -1,17 +1,15 @@
-name: Generate Python Documentation
+name: Documentation
 
-on: [pull_request]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
 
 jobs:
   build-docs:
     runs-on: ubuntu-22.04
     steps:
-    - name: Install SSH_KEYS
-      uses: webfactory/ssh-agent@v0.8.0
-      with:
-        ssh-private-key: |
-            ${{ secrets.SSH_PRIVATE_KEY_REACHY2_SDK_API }}
-
     - name: Checkout Repository
       uses: actions/checkout@v3
 
@@ -26,10 +24,27 @@ jobs:
         pip install .[dev]
 
     - name: Generate Documentation
-      run: pdoc reachy2_sdk --output-dir docs --logo "https://www.pollen-robotics.com/img/company/logo/pollen_logo_square_black.svg"
+      run: pdoc reachy2_sdk --output-dir docs --logo "https://pollen-robotics.github.io/reachy2-sdk/pollen_logo.png" --logo-link "https://www.pollen-robotics.com" --docformat google
 
     - name: Archive Documentation
       uses: actions/upload-artifact@v4
       with:
         name: documentation
         path: docs/
+
+  publish-docs:
+    needs: build-docs
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Download Documentation
+        uses: actions/download-artifact@v4
+        with:
+          name: documentation
+          path: docs/
+            
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
\ No newline at end of file
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index b18a5388..8d3987e6 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -16,11 +16,6 @@ jobs:
   isort:
     runs-on: ubuntu-22.04
     steps:
-      - name: Install SSH_KEYS
-        uses: webfactory/ssh-agent@v0.8.0
-        with:
-          ssh-private-key: |
-            ${{ secrets.SSH_PRIVATE_KEY_REACHY2_SDK_API }}
       - uses: actions/checkout@v3
       - name: Set up Python 3.10
         uses: actions/setup-python@v4
@@ -37,11 +32,6 @@ jobs:
   flake8:
     runs-on: ubuntu-22.04
     steps:
-      - name: Install SSH_KEYS
-        uses: webfactory/ssh-agent@v0.8.0
-        with:
-          ssh-private-key: |
-            ${{ secrets.SSH_PRIVATE_KEY_REACHY2_SDK_API }}
       - uses: actions/checkout@v3
       - name: Set up Python 3.10
         uses: actions/setup-python@v4
@@ -62,11 +52,6 @@ jobs:
   mypy:
     runs-on: ubuntu-22.04
     steps:
-      - name: Install SSH_KEYS
-        uses: webfactory/ssh-agent@v0.8.0
-        with:
-          ssh-private-key: |
-            ${{ secrets.SSH_PRIVATE_KEY_REACHY2_SDK_API }}
       - uses: actions/checkout@v3
       - name: Set up Python 3.10
         uses: actions/setup-python@v4
diff --git a/.gitignore b/.gitignore
index 05169bac..b8bfbd43 100644
--- a/.gitignore
+++ b/.gitignore
@@ -164,4 +164,6 @@ cython_debug/
 #.idea/
 
 # ignore documentation generated locally. It's done by github
-docs/
\ No newline at end of file
+docs/*.html
+docs/*.js
+docs/reachy2_sdk/
\ No newline at end of file
diff --git a/README.md b/README.md
index b27ed644..f54a1e4c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,11 @@
 # Python SDK for Reachy 2
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) ![linter](https://github.com/pollen-robotics/reachy2-sdk/actions/workflows/lint.yml/badge.svg) ![pytest](https://github.com/pollen-robotics/reachy2-sdk/actions/workflows/unit_tests.yml/badge.svg) ![coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/FabienDanieau/92452aca5c894f95fb934dc2a7a6815f/raw/covbadge.json)
+[![Licence](https://img.shields.io/badge/licence-Apache%202.0-blue)](LICENSE) 
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) 
+![linter](https://github.com/pollen-robotics/reachy2-sdk/actions/workflows/lint.yml/badge.svg) 
+![pytest](https://github.com/pollen-robotics/reachy2-sdk/actions/workflows/unit_tests.yml/badge.svg) 
+![coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/FabienDanieau/92452aca5c894f95fb934dc2a7a6815f/raw/covbadge.json)
+![Docs](https://github.com/pollen-robotics/python-template/actions/workflows/docs.yml/badge.svg)
 
 ## Install
 
@@ -18,9 +23,14 @@ Check out the [examples](src/examples/) folder for jupyter notebooks and example
 
 ## Documentation
 
-Documentation is generated via pdoc. It can be generated locally with:
+Documentation is generated via pdoc, and it's available at [https://pollen-robotics.github.io/reachy2-sdk/reachy2_sdk.html](https://pollen-robotics.github.io/reachy2-sdk/reachy2_sdk.html)
+
+
+It can be generated locally with:
 ```console
-pdoc reachy2_sdk --output-dir docs --logo "https://www.pollen-robotics.com/img/company/logo/pollen_logo_square_black.svg"
+pdoc reachy2_sdk --output-dir docs --logo "https://pollen-robotics.github.io/reachy2-sdk/pollen_logo.png" --logo-link "https://www.pollen-robotics.com" --docformat google
+
+
 ```
 
 ## Unit tests
diff --git a/docs/pollen_logo.png b/docs/pollen_logo.png
new file mode 100644
index 00000000..35bfa297
Binary files /dev/null and b/docs/pollen_logo.png differ
diff --git a/src/reachy2_sdk/__init__.py b/src/reachy2_sdk/__init__.py
index 65c450ee..9146586e 100644
--- a/src/reachy2_sdk/__init__.py
+++ b/src/reachy2_sdk/__init__.py
@@ -13,7 +13,7 @@
 
 And you're ready to use Reachy!
 
-*Examples and tutorials are available [here](../src/examples/)!*
+*Examples and tutorials are available [here](https://github.com/pollen-robotics/reachy2-sdk/tree/main/src/examples)!*
 
 """
 


Test patch:
diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml
index 68c1b759..49804d74 100644
--- a/.github/workflows/unit_tests.yml
+++ b/.github/workflows/unit_tests.yml
@@ -8,12 +8,6 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-      - name: Install SSH_KEYS
-        uses: webfactory/ssh-agent@v0.8.0
-        with:
-          ssh-private-key: |
-            ${{ secrets.SSH_PRIVATE_KEY_REACHY2_SDK_API }}
-
       - uses: actions/checkout@v3
       - name: Set up Python 3.10
         uses: actions/setup-python@v4