griffe 2.3.0__tar.gz → 2.3.2__tar.gz

{griffe-2.3.0 → griffe-2.3.2}/.gitignore

@@ -1,6 +1,10 @@
 # editors
 .idea/
 .vscode/
+.zed
+
+# environment
+.env
 
 # python
 *.egg-info/
@@ -13,6 +17,7 @@ dist/
 # tools
 .coverage*
 /.pdm-build/
+/docs/griffe.json
 /htmlcov/
 /site/
 uv.lock

griffe-2.3.2/AI_POLICY.md

@@ -0,0 +1,15 @@
+# AI Contribution Policy
+
+We accept AI-*assisted* contributions, both for code and documentation, with the following expectations:
+
+- AI-assisted contributions must disclaim their use of AI.
+- Contributors must fully understand the proposed changes and be able to explain why they are the correct approach.
+- Issues must be created before creating pull requests (unless there is already a relevant issue).
+- Issue and pull request templates must be followed.
+- Comments (including bodies) in issues and pull requests must be written by humans. If you use LLMs to translate from one language to another, please include your original comment and the translated one.
+- Git commits must be authored by humans, not AI/bot accounts or identities.
+- Git commit messages must be written by humans, in English. If you cannot write English, please state so in the pull request body and we will write the commit messages ourselves.
+
+Failure to comply with any of these requirements will result in issues or pull requests being closed immediately without comment. Repeated violations of this policy will result in a ban of the offending accounts/identities from contributing to this project and any related project from the same author/organization.
+
+We do not accept AI-generated content in community spaces we maintain or moderate, such as GitHub discussions or Matrix rooms.

{griffe-2.3.0 → griffe-2.3.2}/CHANGELOG.md

@@ -5,6 +5,26 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [2.3.2](https://github.com/mkdocstrings/griffe/releases/tag/2.3.2) - 2026-10-06
+
+<small>[Compare with 2.3.1](https://github.com/mkdocstrings/griffe/compare/2.3.1...2.3.2)</small>
+
+### Build
+
+- Drop support for Python 3.10 in griffelib and griffecli packages ([7c45a8f](https://github.com/mkdocstrings/griffe/commit/7c45a8f9785d085b38a2809d98d11faabfd5a5b5) by Timothée Mazzucotelli).
+
+## [2.3.1](https://github.com/mkdocstrings/griffe/releases/tag/2.3.1) - 2026-10-06
+
+<small>[Compare with 2.3.0](https://github.com/mkdocstrings/griffe/compare/2.3.0...2.3.1)</small>
+
+### Build
+
+- Drop support for Python 3.10 ([686993d](https://github.com/mkdocstrings/griffe/commit/686993d4970d9fabbbd33334f88f48e1daed0565) by Timothée Mazzucotelli).
+
+### Bug Fixes
+
+- Exit gracefully when checking API and no tags are found ([7c898a9](https://github.com/mkdocstrings/griffe/commit/7c898a9685c8ac29e1a4fd7767e85bf830b75a58) by Timothée Mazzucotelli).
+
 ## [2.3.0](https://github.com/mkdocstrings/griffe/releases/tag/2.3.0) - 2026-09-04
 
 <small>[Compare with 2.2.0](https://github.com/mkdocstrings/griffe/compare/2.2.0...2.3.0)</small>

{griffe-2.3.0 → griffe-2.3.2}/LICENSE

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2021, Timothée Mazzucotelli
+Copyright (c) 2021, Timothée Mazzucotelli and contributors
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

{griffe-2.3.0 → griffe-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: griffe
-Version: 2.3.0
+Version: 2.3.2
 Summary: Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API.
 Project-URL: Homepage, https://mkdocstrings.github.io/griffe
 Project-URL: Documentation, https://mkdocstrings.github.io/griffe
@@ -19,27 +19,27 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Python: >=3.10
-Requires-Dist: griffecli==2.3.0
-Requires-Dist: griffelib==2.3.0
+Requires-Python: >=3.11
+Requires-Dist: griffecli==2.3.2
+Requires-Dist: griffelib==2.3.2
 Provides-Extra: pypi
-Requires-Dist: griffelib[pypi]==2.3.0; extra == 'pypi'
+Requires-Dist: griffelib[pypi]==2.3.2; extra == 'pypi'
 Description-Content-Type: text/markdown
 
 # Griffe
 
 [![ci](https://github.com/mkdocstrings/griffe/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe/actions?query=workflow%3Aci)
-[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe/)
+[![documentation](https://img.shields.io/badge/docs-zensical-FF9100.svg?style=flat)](https://mkdocstrings.github.io/griffe/)
 [![pypi version](https://img.shields.io/pypi/v/griffe.svg)](https://pypi.org/project/griffe/)
 [![gitter](https://img.shields.io/badge/matrix-chat-4db798.svg?style=flat)](https://app.gitter.im/#/room/#mkdocstrings_griffe:gitter.im)
 [![radicle](https://img.shields.io/badge/rad-clone-6666FF.svg?style=flat)](https://app.radicle.at/nodes/seed.radicle.at/rad:z4M5XTPDD4Wh1sm8iPCenF85J3z8Z)

{griffe-2.3.0 → griffe-2.3.2}/README.md

@@ -1,7 +1,7 @@
 # Griffe
 
 [![ci](https://github.com/mkdocstrings/griffe/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe/actions?query=workflow%3Aci)
-[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe/)
+[![documentation](https://img.shields.io/badge/docs-zensical-FF9100.svg?style=flat)](https://mkdocstrings.github.io/griffe/)
 [![pypi version](https://img.shields.io/pypi/v/griffe.svg)](https://pypi.org/project/griffe/)
 [![gitter](https://img.shields.io/badge/matrix-chat-4db798.svg?style=flat)](https://app.gitter.im/#/room/#mkdocstrings_griffe:gitter.im)
 [![radicle](https://img.shields.io/badge/rad-clone-6666FF.svg?style=flat)](https://app.radicle.at/nodes/seed.radicle.at/rad:z4M5XTPDD4Wh1sm8iPCenF85J3z8Z)

{griffe-2.3.0 → griffe-2.3.2}/config/ruff.toml

@@ -1,4 +1,4 @@
-target-version = "py310"
+target-version = "py311"
 line-length = 120
 output-format = "concise"
 
@@ -18,9 +18,9 @@ ignore = [
     "D417",  # Missing argument description in the docstring
     "E501",  # Line too long
     "EM",  # Raw strings in exceptions
-    "FIX001",  # Line contains FIXME
-    "FIX002",  # Line contains TODO
     "ERA001",  # Commented out code
+    "FIX",  # TODO, FIXME, etc.
+    "G004",  # Logging statement uses f-string
     "PD",  # Pandas-related
     "PERF203",  # Try-except block in for loop (zero-cost with Python 3.11+)
     "PLR0911",  # Too many return statements
@@ -30,7 +30,7 @@ ignore = [
     "SLF001",  # Private member accessed
     "TD001",  # Invalid TODO tag: FIXME
     "TD002",  # Missing author in TODO
-    "TD003",  # Missing issue link on the line following this TODO
+    "TD003",  # Missing issue link for TODO
     "TRY003",  # Avoid specifying long messages outside the exception class
     "UP007",  # Use `X | Y` for type annotations
 ]

{griffe-2.3.0 → griffe-2.3.2}/config/vscode/launch.json

@@ -23,11 +23,10 @@
             "name": "docs",
             "type": "debugpy",
             "request": "launch",
-            "module": "mkdocs",
+            "module": "zensical",
             "justMyCode": false,
             "args": [
                 "serve",
-                "-v"
             ]
         },
         {

griffe-2.3.2/config/zed/debug.json

@@ -0,0 +1,44 @@
+// Project-local debug tasks
+//
+// For more documentation on how to configure debug tasks,
+// see: https://zed.dev/docs/debugger
+[
+  {
+    "label": "python (current file)",
+    "adapter": "Debugpy",
+    "request": "launch",
+    "program": "$ZED_FILE",
+    "justMyCode": false
+  },
+  {
+    "label": "run",
+    "adapter": "Debugpy",
+    "request": "launch",
+    "module": "griffe",
+    "justMyCode": false
+  },
+  {
+    "label": "docs",
+    "adapter": "Debugpy",
+    "request": "launch",
+    "module": "zensical",
+    "args": [
+      "serve"
+    ],
+    "justMyCode": false
+  },
+  {
+    "label": "test",
+    "adapter": "Debugpy",
+    "request": "launch",
+    "module": "pytest",
+    "args": [
+      "-c=config/pytest.ini",
+      "-vvv",
+      "--no-cov",
+      "--dist=no",
+      "tests"
+    ],
+    "justMyCode": false
+  }
+]

griffe-2.3.2/config/zed/settings.json

@@ -0,0 +1,43 @@
+// Zed settings
+//
+// For information on how to configure Zed, see the Zed
+// documentation: https://zed.dev/docs/configuring-zed
+//
+// To see all of Zed's default settings without changing your
+// custom settings, run `zed: open default settings` from the
+// command palette (cmd-shift-p / ctrl-shift-p)
+{
+  "languages": {
+    "YAML": {
+      "auto_indent_on_paste": false,
+      "auto_indent": "preserve_indent",
+      "format_on_save": "off"
+    },
+    "Python": {
+      "language_servers": ["ty", "ruff"],
+      "code_actions_on_format": {
+        "source.organizeImports.ruff": true
+      },
+      "formatter": {
+        "language_server": {
+          "name": "ruff"
+        }
+      }
+    }
+  },
+  "lsp": {
+    "ty": {
+      "settings": {
+        "configurationFile": "config/ty.toml"
+      }
+    },
+    "ruff": {
+      "initialization_options": {
+        "settings": {
+          "configurationPreference": "filesystemFirst",
+          "configuration": "config/ruff.toml"
+        }
+      }
+    }
+  }
+}

griffe-2.3.2/config/zed/tasks.json

@@ -0,0 +1,72 @@
+[
+  {
+    "label": "changelog",
+    "command": "scripts/make",
+    "args": ["changelog"]
+  },
+  {
+    "label": "check",
+    "command": "scripts/make",
+    "args": ["check"]
+  },
+  {
+    "label": "check-quality",
+    "command": "scripts/make",
+    "args": ["check-quality"]
+  },
+  {
+    "label": "check-types",
+    "command": "scripts/make",
+    "args": ["check-types"]
+  },
+  {
+    "label": "check-docs",
+    "command": "scripts/make",
+    "args": ["check-docs"]
+  },
+  {
+    "label": "check-api",
+    "command": "scripts/make",
+    "args": ["check-api"]
+  },
+  {
+    "label": "clean",
+    "command": "scripts/make",
+    "args": ["clean"]
+  },
+  {
+    "label": "docs",
+    "command": "scripts/make",
+    "args": ["docs"]
+  },
+  {
+    "label": "docs-deploy",
+    "command": "scripts/make",
+    "args": ["docs-deploy"]
+  },
+  {
+    "label": "format",
+    "command": "scripts/make",
+    "args": ["format"]
+  },
+  {
+    "label": "release",
+    "command": "scripts/make",
+    "args": ["release"]
+  },
+  {
+    "label": "setup",
+    "command": "scripts/make",
+    "args": ["setup"]
+  },
+  {
+    "label": "test",
+    "command": "scripts/make",
+    "args": ["test", "coverage"]
+  },
+  {
+    "label": "vscode",
+    "command": "scripts/make",
+    "args": ["vscode"]
+  }
+]

{griffe-2.3.0 → griffe-2.3.2}/docs/.overrides/partials/comments.html

@@ -1,5 +1,5 @@
 <!-- Giscus -->
-<!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration -->
+<!-- https://zensical.org/docs/setup/comment-system/#giscus-integration -->
 <div id="feedback" style="display: none;">
     <h2 id="__comments">Feedback</h2>
     <script src="https://giscus.app/client.js"

griffe-2.3.0/docs/community.md → griffe-2.3.2/docs/community/index.md

@@ -1,6 +1,6 @@
 # Community
 
-Griffe is part of is the [mkdocstrings](https://mkdocstrings.github.io/) ecosystem, and therefore part of the [MkDocs](https://www.mkdocs.org/) ecosystem too. These two ecosystems have wonderful communities and we invite you to join them :octicons-heart-fill-24:{ .pulse } Make sure to read and follow our [code of conduct](code-of-conduct.md) when engaging with the community.
+Griffe is part of is the [mkdocstrings](https://mkdocstrings.github.io/) ecosystem, and therefore part of the [MkDocs](https://www.mkdocs.org/) ecosystem too. These two ecosystems have wonderful communities and we invite you to join them :octicons-heart-fill-24:{ .pulse } Make sure to read and follow our [code of conduct](../code-of-conduct.md) when engaging with the community.
 
 You can start new discussions on GitHub, in the following repositories, depending on the specificity of the discussion: [griffe](https://github.com/mkdocstrings/griffe), [mkdocstrings-python](https://github.com/mkdocstrings/python), [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings), and [MkDocs](https://github.com/mkdocs/mkdocs).
 
@@ -12,7 +12,7 @@ The best place to share about Griffe is of course our Gitter channel.
 
 More generally, Griffe is also related to **API documentation** and **API analysis** (static or dynamic): if your project is related to these two domains, but in different ecosystems (other programming languages, static site generators, or environments), feel free to drop us a message! We are always happy to share with other actors in these domains :material-handshake:
 
-- [Getting help](getting-help.md)
-- [Contributing](contributing.md)
-- [Code of conduct](code-of-conduct.md)
-- [Credits](credits.md)
+- [Getting help](../getting-help.md)
+- [Contributing](../contributing.md)
+- [Code of conduct](../code-of-conduct.md)
+- [Credits](../credits.md)

{griffe-2.3.0 → griffe-2.3.2}/docs/contributing.md

@@ -16,4 +16,4 @@ There are multiple ways to contribute to this project:
 
 For easy documentation fixes, you can edit a file and send a pull request [directly from the GitHub web interface](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files#editing-files-in-another-users-repository). For more complex fixes or improvements, please read our contributor guide. The guide will show you how to set up a development environment to run tests or serve the documentation locally.
 
-[:fontawesome-solid-helmet-safety: Contributor guide](guide/contributors.md){ .md-button }
+[:fontawesome-solid-helmet-safety: Contributor guide](guide/contributors/index.md){ .md-button }