Add note block parser, fixes #1

Author: krassowski

docstring_to_markdown/rst.py

@@ -281,6 +281,17 @@ def initiate_parsing(self, line: str, current_language: str):
         return IBlockBeginning(remainder='')
 
 
+class NoteBlockParser(IndentedBlockParser):
+    enclosure = '\n---'
+
+    def can_parse(self, line: str):
+        return line.strip() == '.. note::'
+
+    def initiate_parsing(self, line: str, current_language: str):
+        self._start_block('\n**Note**\n')
+        return IBlockBeginning(remainder='')
+
+
 class ExplicitCodeBlockParser(IndentedBlockParser):
     def can_parse(self, line: str) -> bool:
         return re.match(CODE_BLOCK_PATTERN, line) is not None
@@ -293,6 +304,7 @@ def initiate_parsing(self, line: str, current_language: str) -> IBlockBeginning:
 
 BLOCK_PARSERS = [
     PythonPromptCodeBlockParser(),
+    NoteBlockParser(),
     MathBlockParser(),
     ExplicitCodeBlockParser(),
     DoubleColonBlockParser()

setup.cfg

@@ -25,12 +25,13 @@ python_requires = >=3.6
 
 [tool:pytest]
 addopts =
-    --pyargs docstring_to_markdown
+    --pyargs tests
     --cov docstring_to_markdown
-    --cov-fail-under=40
+    --cov-fail-under=92
     --cov-report term-missing:skip-covered
     -p no:warnings
     --flake8
+    -vv
 
 [flake8]
 max-line-length = 120

tests/test_rst.py

@@ -72,7 +72,7 @@
 RST_LINK_EXAMPLE = """To learn more about the frequency strings, please see `this link
 <https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases>`__."""
 RST_LINK_EXAMPLE_MARKDOWN = (
-    "To learn more about the frequency strings, please see"
+    "To learn more about the frequency strings, please see "
     "[this link](https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases)."
 )
 RST_REF_EXAMPLE = """See :ref:`here <timeseries.offset_aliases>` for a list of frequency aliases."""
@@ -225,6 +225,31 @@ def func(): pass
 ```
 """
 
+NUMPY_NOTE = """
+operations and methods.
+
+.. note::
+   The `chararray` class exists for backwards compatibility with
+   Numarray, it is not recommended for new development.
+
+Some methods will only be available if the corresponding string method is
+"""
+
+NUMPY_NOTE_MARKDOWN = """
+operations and methods.
+
+
+---
+**Note**
+
+The `chararray` class exists for backwards compatibility with
+Numarray, it is not recommended for new development.
+
+---
+
+Some methods will only be available if the corresponding string method is
+"""
+
 RST_MATH_EXAMPLE = """
 In two dimensions, the DFT is defined as
 
@@ -341,5 +366,7 @@ def test_rst_to_markdown_prompt_continuation():
     assert (
         rst_to_markdown('Discrete Fourier Transform (:mod:`numpy.fft`)') == 'Discrete Fourier Transform (`numpy.fft`)'
     )
+
+    assert rst_to_markdown(NUMPY_NOTE) == NUMPY_NOTE_MARKDOWN