documentation #41: publish page

Author: FabienDanieau

.github/workflows/docs.yml

@@ -43,3 +43,19 @@ jobs:
       with:
         name: documentation
         path: docs/
+
+  publish-docs:
+    needs: build-docs
+    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@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs

src/example/foo.py

@@ -45,10 +45,12 @@ def __del__(self) -> None:
         self._logger.info("Destructor")
 
     @overload
-    def doingstuffs(self, var: int, var2: float) -> None: ...
+    def doingstuffs(self, var: int, var2: float) -> None:
+        ...
 
     @overload
-    def doingstuffs(self, var: int) -> None: ...
+    def doingstuffs(self, var: int) -> None:
+        ...
 
     def doingstuffs(self, var: Any = None, var2: Any = None) -> None:
         """An overloaded method that takes one or two arguments and logs their values and types.