Merge pull request #14 from DanielAvdar/docs-dbot

Docs dbot

Author: DanielAvdar

.github/workflows/codecov.yml

@@ -25,8 +25,6 @@ jobs:
           fail_ci_if_error: true
           verbose: true
           token: ${{ secrets.CODECOV_TOKEN }}
-
-
       - uses: codecov/test-results-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/docs.yml

@@ -22,7 +22,7 @@ jobs:
           enable-cache: true
       - run: uv python install 3.11
 
-      - run: make
+      - run: make install-docs
       - run: make doc
 
       - name: Deploy

.github/workflows/publish.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: astral-sh/setup-uv@v5
       - run: uv python install 3.11
-      - run: uv sync --all-extras
+      - run: make
       - run: make test
       - run: uv build
       - run: uv publish --token  ${{ secrets.PYPI_API_TOKEN }}

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
       - id: trailing-whitespace
       - id: no-commit-to-branch
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.4
+    rev: v0.11.5
     hooks:
       - id: ruff-format
         args: [ --preview, --config=pyproject.toml ]

.readthedocs.yaml

@@ -13,10 +13,10 @@ formats: all
 
 # Set the OS, Python version, and other tools you might need
 build:
-  os: ubuntu-24.04
+  os: ubuntu-lts-latest
   tools:
     python: "3.12"
   jobs:
     post_install:
       - pip install uv
-      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --all-groups --link-mode=copy
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --group docs --link-mode=copy --frozen --no-group dev

Makefile

@@ -7,6 +7,9 @@ install:
 	uv sync --all-extras --all-groups --frozen
 	uv tool install pre-commit --with pre-commit-uv --force-reinstall
 
+install-docs:
+	uv sync --group docs --frozen --no-group dev
+
 update:
 	uv lock
 	uvx pre-commit autoupdate

pyproject.toml

@@ -24,12 +24,14 @@ dev = [
     "mypy==1.13.0",
     "pytest-parametrization>=2022",
     "ruff>=0.8.2",
+
+]
+docs = [
     "sybil[pytest]",
     "sphinx>=8.2.0; python_version >= '3.11'",
     "sphinx>=7.0.0; python_version < '3.11'",
     "sphinx-rtd-theme>=3.0.2",
 ]
-
 [tool.hatch.build.targets.sdist]
 only-include = ["my_pkg",] # todo: change to your package name
 source = "."