Updated sphinx documentation config

.github/workflows/publish.yml

@@ -1,9 +1,11 @@
 name: Publish to PyPI
 
 on:
-  push:
-    tags:
-      - "*"
+  workflow_run:
+    workflows:
+      - Auto Version Tag
+    types:
+      - completed
 
 jobs:
   publish:
@@ -11,8 +13,13 @@ jobs:
     environment: release
     steps:
       - uses: actions/checkout@v4
-      - name: Install uv
-        run: pip install uv
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "${{ matrix.python-version }}"
+          enable-cache: true
+          cache-dependency-glob: |
+            pyproject.toml
       - name: Build package
         run: uv build
       - name: Publish to PyPI

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+  jobs:
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+    create_environment:
+      - uv sync --group docs
+    install:
+      - uv run python -m sphinx -T -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html

docs/conf.py

@@ -47,8 +47,8 @@ master_doc = "index"
 
 # General information about the project.
 project = "invenio-config-iform"
-copyright = "2022, TU Graz"
-author = "TU Graz"
+copyright = "2025, I-Form"
+author = "I-Form"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -109,10 +109,10 @@ html_theme = "alabaster"
 
 html_theme_options = {
     "description": "invenio module that adds iform configs.",
-    "github_user": "TU Graz",
+    "github_user": "Cian-H",
     "github_repo": "invenio-config-iform",
-    "github_button": False,
-    "github_banner": True,
+    "github_button": True,
+    "github_banner": False,
     "show_powered_by": False,
     "extra_nav_links": {
         "invenio-config-iform@Github": "https://github.com/Cian-H/invenio-config-iform",
@@ -244,7 +244,7 @@ latex_documents = [
         master_doc,
         "invenio-config-iform.tex",
         "invenio-config-iform Documentation",
-        "Mojib Wali",
+        "I-Form",
         "manual",
     ),
 ]

invenio_config_iform/__about__.py

@@ -8,4 +8,4 @@
 
 """Metadata for this python module."""
 
-__version__ = "2025.5.20.2"
+__version__ = "2025.5.20.11"

pyproject.toml

@@ -67,6 +67,11 @@ tests = [
     "ruff>=0.5.3",
     "Sphinx>=4.5.0",
 ]
+docs = [
+    "invenio-app>=1.5.0",
+    "invenio-search[opensearch2]>=2.1.0",
+    "Sphinx>=4.5.0",
+]
 
 [build-system]
 requires = ["hatchling", "hatch-calver"]

uv.lock

@@ -1722,6 +1722,11 @@ dev = [
     { name = "pydocstyle" },
     { name = "ruff" },
 ]
+docs = [
+    { name = "invenio-app" },
+    { name = "invenio-search", extra = ["opensearch2"] },
+    { name = "sphinx" },
+]
 tests = [
     { name = "invenio-app" },
     { name = "invenio-search", extra = ["opensearch2"] },
@@ -1745,6 +1750,11 @@ dev = [
     { name = "pydocstyle", specifier = ">=6.3.0" },
     { name = "ruff", specifier = ">=0.11.7" },
 ]
+docs = [
+    { name = "invenio-app", specifier = ">=1.5.0" },
+    { name = "invenio-search", extras = ["opensearch2"], specifier = ">=2.1.0" },
+    { name = "sphinx", specifier = ">=4.5.0" },
+]
 tests = [
     { name = "invenio-app", specifier = ">=1.5.0" },
     { name = "invenio-search", extras = ["opensearch2"], specifier = ">=2.1.0" },