Fix env caching (#79)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: flying-sheep

.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+          cache: "pip"
+          cache-dependency-path: pyproject.toml
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip wheel
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.readthedocs.yml

@@ -11,3 +11,4 @@ python:
         - doc
 sphinx:
   configuration: docs/conf.py
+  fail_on_warning: true

docs/conf.py

@@ -1,16 +1,10 @@
 from datetime import datetime
 from importlib.metadata import metadata
-from pathlib import Path
+from pathlib import PurePosixPath
 
 from sphinx.application import Sphinx
 
 
-HERE = Path(__file__).parent
-
-# Clean build env
-for file in HERE.glob("scanpydoc.*.rst"):
-    file.unlink()
-
 extensions = [
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
@@ -56,7 +50,7 @@
     use_repository_button=True,
 )
 
-rtd_links_prefix = "src"
+rtd_links_prefix = PurePosixPath("src")
 
 
 def setup(app: Sphinx):

src/scanpydoc/elegant_typehints/__init__.py

@@ -47,6 +47,8 @@ def x() -> Tuple[int, float]:
 from __future__ import annotations
 
 from collections import ChainMap
+from collections.abc import Callable
+from dataclasses import dataclass
 from functools import partial
 from pathlib import Path
 from typing import Any
@@ -91,6 +93,13 @@ def _init_vars(app: Sphinx, config: Config):
     config.html_static_path.append(str(HERE / "static"))
 
 
+@dataclass
+class PickleableCallable:
+    func: Callable
+
+    __call__ = property(lambda self: self.func)
+
+
 @_setup_sig
 def setup(app: Sphinx) -> dict[str, Any]:
     """Patches :mod:`sphinx_autodoc_typehints` for a more elegant display."""
@@ -103,7 +112,7 @@ def setup(app: Sphinx) -> dict[str, Any]:
 
     from .formatting import _role_annot, format_annotation
 
-    app.config.typehints_formatter = format_annotation
+    app.config["typehints_formatter"] = PickleableCallable(format_annotation)
     for name in ["annotation-terse", "annotation-full"]:
         roles.register_canonical_role(
             name, partial(_role_annot, additional_classes=name.split("-"))