Create documentation_workflow.yml

.github/workflows/documentation_workflow.yml

@@ -0,0 +1,27 @@
+name: 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_mdinclude furo                                                                                                  
+      - name: Sphinx build                                                                                                                                         
+        run: |                                                                                                                                                     
+          sphinx-build -M html doc/source/ doc/build/                                                                                                            
+      - name: Deploy to GitHub Pages                                                                                                                               
+        uses: peaceiris/actions-gh-pages@v3                                                                                                                        
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}                                                                                  
+        with:                                                                                                                                                      
+          publish_branch: gh-pages                                                                                                                                 
+          github_token: ${{ secrets.GITHUB_TOKEN }}                                                                                                                
+          publish_dir: docs/build/html                                                                                                                             
+          force_orphan: true