Docs publishing

.github/workflows/docs-publish.yml

@@ -0,0 +1,29 @@
+name: "Sphinx: Render docs"
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build docs
+      run: |
+        pip install -r ./docs/source/requirements.txt
+        pip install -r ./requirements.txt
+        sphinx-build -M html docs/source docs/build
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: html-docs
+        path: docs/build/html/
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html

.github/workflows/pypi-publish.yml → .github/workflows/test-pypi-publish.yml

@@ -3,7 +3,7 @@ name: Publish Package
 on: push
 
 env:
-  version: ${{ github.run_id }}-${{ github.run_attempt }}
+  version: ${{ github.run_id }}.post${{ github.run_attempt }}
 
 jobs:
   build:
@@ -63,6 +63,7 @@ jobs:
 
     permissions:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
+    if: github.ref == 'refs/heads/dev'
 
     steps:
     - name: Download all the dists
@@ -74,3 +75,7 @@ jobs:
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
         repository-url: https://test.pypi.org/legacy/
+    - name: Test
+      run: |
+        echo Release published on https://test.pypi.org/project/Py-SPW/$version/
+        echo Install - pip install -i https://test.pypi.org/simple/ Py-SPW==$version

docs/source/conf.py

@@ -5,6 +5,7 @@
 
 import os
 import sys
+from datetime import datetime
 
 sys.path.insert(0, os.path.abspath('../..'))
 
@@ -14,7 +15,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'Py-SPW'
-copyright = '2023, Teleport'
+copyright = f'{datetime.now().year}, Teleport'
 author = 'Teleport'
 release = __version__
 

docs/source/requirements.txt

@@ -1 +1,2 @@
+sphinx==5.3.0
 furo==2023.3.27