wip

Author: pawamoy

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)
@@ -168,4 +168,7 @@ See the [Loading chapter](https://mkdocstrings.github.io/griffe/guide/users/load
 
 *And 7 more private sponsor(s).*
 
+## Sponsors
+
+<!-- sponsors-start -->
 <!-- sponsors-end -->

config/ruff.toml

@@ -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
 ]

config/vscode/launch.json

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

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"

docs/.overrides/partials/path-item.html

@@ -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)