Add CI on documentation

.github/workflows/documentation.yml

@@ -0,0 +1,56 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy Sphinx documentation to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          check-latest: true
+          cache: 'pip'
+          cache-dependency-path: './docs/requirements.txt'
+      - name: Install dependencies
+        run: |
+          pip install -r ./docs/requirements.txt
+      - name: Build documentation
+        run: |
+          sphinx-build -M html ./docs/source _build/
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: '_build/'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,2 @@
+# IDE settings
+.idea

README.md

@@ -2,7 +2,7 @@
 
 ## What can it do ?
 
-- [ ] compile and deploy documentation
+- [x] compile and deploy documentation
 - [ ] create a release
 - [ ] add automatic publication on pypi
 - [ ] add automatic publication on conda repository

docs/requirements.txt

@@ -0,0 +1 @@
+sphinx-rtd-theme

docs/conf.py → docs/source/conf.py

@@ -17,9 +17,8 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'icetrackpy'
-copyright = '2024, Martin THIRIET'
-author = 'Martin THIRIET'
+project = 'python_lib_quickstart'
+author = 'IGE Calcul'
 
 # The full version, including alpha/beta/rc tags
 release = '0.1'

docs/func_o.rst → docs/source/func_o.rst

@@ -3,6 +3,6 @@ Functions overview
 
 My awesome function
 *******************
-.. automodule:: pylib_quick.pylib_quick
+.. automodule:: python_lib_quickstart.python_lib_quickstart
 	:special-members:
 	:members:

docs/index.rst → docs/source/index.rst

@@ -1,9 +1,9 @@
-.. pylib_quick documentation master file, created by
+.. python_lib_quickstart documentation master file, created by
    sphinx-quickstart on Mon Aug  2 09:58:09 2021.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to pylib_quick documentation!
+Welcome to python_lib_quickstart documentation!
 =======================================
 
 In this documentation detail of the functions are given. 

environment.yml

@@ -6,5 +6,3 @@ channels:
 dependencies:
   - python=3.11
   - pip
-  - pip :
-    - sphinx-rtd-theme

setup.py

@@ -12,13 +12,13 @@
 from setuptools import find_packages, setup, Command
 
 # Package meta-data.
-NAME = 'pylib_quick'
-DESCRIPTION = 'python package'
-URL = 'https://gricad-gitlab.univ-grenoble-alpes.fr/quicktools/pylib_quick'
+NAME = 'python_lib_quickstart'
+DESCRIPTION = 'python library packaging example'
+URL = 'https://github.com/ige-calcul/python_lib_quickstart'
 EMAIL = '[email protected]'
 AUTHOR = 'Thomas Chauve'
 REQUIRES_PYTHON = '>=3.11'
-VERSION = '0.2'
+VERSION = '0.3'
 
 # What packages are required for this module to be executed?
 REQUIRED = [