File tree 2 files changed +14
-0
lines changed
src/pytkdocs/parsers/docstrings
2 files changed +14
-0
lines changed Original file line number Diff line number Diff line change 4
4
5
5
from pytkdocs .parsers .docstrings .base import Parser , UnavailableParser
6
6
from pytkdocs .parsers .docstrings .google import Google
7
+ from pytkdocs .parsers .docstrings .markdown import Markdown
7
8
from pytkdocs .parsers .docstrings .restructured_text import RestructuredText
8
9
9
10
try :
18
19
"google" : Google ,
19
20
"restructured-text" : RestructuredText ,
20
21
"numpy" : Numpy ,
22
+ "markdown" : Markdown ,
21
23
}
Original file line number Diff line number Diff line change
1
+ """This module defines functions and classes to parse docstrings into structured data."""
2
+
3
+ from typing import List
4
+
5
+ from pytkdocs .parsers .docstrings .base import Parser , Section
6
+
7
+
8
+ class Markdown (Parser ):
9
+ """A Markdown docstrings parser."""
10
+
11
+ def parse_sections (self , docstring : str ) -> List [Section ]: # noqa: D102
12
+ return [Section (Section .Type .MARKDOWN , docstring )]
You can’t perform that action at this time.
0 commit comments