Merge pull request #1247 from RonnyPfannschmidt/merge-main

merge from main to develop

Author: RonnyPfannschmidt

.gitignore

@@ -42,7 +42,6 @@ htmlcov/
 .cache
 .pytest_cache
 .mypy_cache/
-.entangled/
 
 nosetests.xml
 coverage.xml

docs/integrations.md

@@ -122,7 +122,7 @@ jobs:
     env:
       # Replace MYPACKAGE with your actual package name (normalized)
       # For package "my-awesome.package", use "MY_AWESOME_PACKAGE"
-      SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
+      SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
 
     steps:
     - uses: actions/checkout@v4
@@ -154,7 +154,7 @@ jobs:
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     env:
       # Replace MYPACKAGE with your actual package name (normalized)
-      SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
+      SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
 
     steps:
     - uses: actions/checkout@v4
@@ -246,7 +246,7 @@ publish-test-pypi:
     TWINE_USERNAME: __token__
     TWINE_PASSWORD: $TEST_PYPI_API_TOKEN
     # Replace MYPACKAGE with your actual package name (normalized)
-    SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
+    SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
   script:
     - pip install build twine
     - python -m build
@@ -261,7 +261,7 @@ publish-pypi:
     TWINE_USERNAME: __token__
     TWINE_PASSWORD: $PYPI_API_TOKEN
     # Replace MYPACKAGE with your actual package name (normalized)
-    SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
+    SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
   script:
     - pip install build twine
     - python -m build
@@ -296,7 +296,7 @@ The environment variable `SETUPTOOLS_SCM_OVERRIDES_FOR_${DIST_NAME}` must be set
 
 2. **Value** must be a valid TOML inline table format:
    ```bash
-   SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE='{"local_scheme": "no-local-version"}'
+   SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE='{local_scheme = "no-local-version"}'
    ```
 
 #### Alternative Approaches
@@ -342,4 +342,4 @@ print(f"SETUPTOOLS_SCM_OVERRIDES_FOR_{env_var_name}")
 # Output: SETUPTOOLS_SCM_OVERRIDES_FOR_MY_AWESOME_PACKAGE
 ```
 
-**Fetch depth**: Always use `fetch-depth: 0` in GitHub Actions to ensure setuptools-scm has access to the full git history for proper version calculation.
+**Fetch depth**: Always use `fetch-depth: 0` in GitHub Actions to ensure setuptools-scm has access to the full git history for proper version calculation.

docs/usage.md

@@ -218,7 +218,7 @@ metadata is present.
 
 The recommended approach for Sphinx configurations is to use the installed package metadata:
 
-``` {.python file=docs/.entangled/sphinx_conf.py}
+```python
 from importlib.metadata import version as get_version
 release: str = get_version("package-name")
 # for example take major/minor

mkdocs.yml

@@ -26,15 +26,14 @@ markdown_extensions:
   - pymdownx.superfences
 
 plugins:
-- entangled
 - search
 - include-markdown
 - mkdocstrings:
     default_handler: python
     handlers:
       python:
         paths: [ setuptools-scm/src, vcs-versioning/src ]
-        import:
+        inventories:
           - https://docs.python.org/3/objects.inv
         options:
           separate_signature: true

pyproject.toml

@@ -17,10 +17,9 @@ create-release-proposal = "vcs_versioning_workspace.create_release_proposal:main
 [dependency-groups]
 docs = [
   "mkdocs",
-  "mkdocs-entangled-plugin",
   "mkdocs-include-markdown-plugin",
   "mkdocs-material",
-  "mkdocstrings[python]",
+  "mkdocstrings[python]>=0.29",  # 0.29 renamed import to inventories
   "pygments",
   "griffe-public-wildcard-imports",
 ]

setuptools-scm/hatch.toml

@@ -15,5 +15,4 @@ extras = ["docs"]
 [envs.docs.scripts]
 build = "mkdocs build --clean --strict"
 serve = "mkdocs serve --dev-addr localhost:8000"
-init = "mkdocs {args}"
-sync = ["entangled sync"]
+init = "mkdocs {args}"

setuptools-scm/pyproject.toml

@@ -75,7 +75,7 @@ test = [
   "pytest-xdist",
   "rich",
   "ruff",
-  "mypy",
+  "mypy; implementation_name != 'pypy'",
   'typing-extensions; python_version < "3.11"',
   "griffe",
   "griffe-public-wildcard-imports",