File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff 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
Original file line number Diff line number Diff 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 ]
3436Homepage = " https://mkdocstrings.github.io/griffe-sphinx"
Original file line number Diff line number Diff line change 55
66from __future__ import annotations
77
8- __all__ : list [str ] = []
8+ from griffe_sphinx ._internals .extension import SphinxCommentsExtension
9+
10+ __all__ : list [str ] = ["SphinxCommentsExtension" ]
Original file line number Diff line number Diff line change 1+ import griffe
2+
3+
4+ class SphinxCommentsExtension (griffe .Extension ):
5+ """Parse Sphinx-comments above attributes as docstrings."""
You can’t perform that action at this time.
0 commit comments