improve source locations for auxiliary packages in docs

pydantic · Jul 19, 2023 · e28a9a1 · e28a9a1
1 parent d249af9
commit e28a9a1
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -59,6 +59,16 @@ jobs:
         pdm install -G docs
 
     - run: pdm run python -c 'import docs.plugins.main'
+    # Adding local symlinks gets nice source locations like
+    #   pydantic_core/core_schema.py
+    # instead of
+    #   .venv/lib/python3.10/site-packages/pydantic_core/core_schema.py
+    - name: prepare shortcuts for extra modules
+      run: |
+        ln -s .venv/lib/python*/site-packages/pydantic_core pydantic_core
+        ln -s .venv/lib/python*/site-packages/pydantic_settings pydantic_settings
+        ln -s .venv/lib/python*/site-packages/pydantic_extra_types pydantic_extra_types
+
     - run: pdm run mkdocs build
 
   test-memray: