File tree Expand file tree Collapse file tree
src/pytkdocs/parsers/docstrings Expand file tree Collapse file tree Original file line number Diff line number Diff line change 44
55from pytkdocs .parsers .docstrings .base import Parser , UnavailableParser
66from pytkdocs .parsers .docstrings .google import Google
7+ from pytkdocs .parsers .docstrings .markdown import Markdown
78from pytkdocs .parsers .docstrings .restructured_text import RestructuredText
89
910try :
1819 "google" : Google ,
1920 "restructured-text" : RestructuredText ,
2021 "numpy" : Numpy ,
22+ "markdown" : Markdown ,
2123}
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