Skip to content

Commit da0ef37

Browse files
committed
feat: Implement no-op extension
1 parent cc9bc69 commit da0ef37

5 files changed

Lines changed: 12 additions & 2 deletions

File tree

config/ruff.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ ignore = [
3333
"ANN401", # Dynamically typed expressions (typing.Any) are disallowed
3434
"ARG005", # Unused lambda argument
3535
"C901", # Too complex
36+
"D100", # Missing docstring in public module
3637
"D105", # Missing docstring in magic method
3738
"D417", # Missing argument description in the docstring
3839
"E501", # Line too long

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ classifiers = [
2828
"Topic :: Utilities",
2929
"Typing :: Typed",
3030
]
31-
dependencies = []
31+
dependencies = [
32+
"griffe>=0.48",
33+
]
3234

3335
[project.urls]
3436
Homepage = "https://mkdocstrings.github.io/griffe-sphinx"

src/griffe_sphinx/__init__.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@
55

66
from __future__ import annotations
77

8-
__all__: list[str] = []
8+
from griffe_sphinx._internals.extension import SphinxCommentsExtension
9+
10+
__all__: list[str] = ["SphinxCommentsExtension"]

src/griffe_sphinx/_internals/__init__.py

Whitespace-only changes.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import griffe
2+
3+
4+
class SphinxCommentsExtension(griffe.Extension):
5+
"""Parse Sphinx-comments above attributes as docstrings."""

0 commit comments

Comments
 (0)