Merge pull request #9 from krassowski/feature/simple-table-with-indent

Parse indented tables

Author: krassowski

docstring_to_markdown/rst.py

@@ -198,20 +198,22 @@ class State(IntEnum):
         PARSING_ROWS = auto()
         FINISHED = auto()
 
-    outer_border_pattern = r'^=+( +=+)+$'
+    outer_border_pattern = r'^(\s*)=+( +=+)+$'
 
     _state: int
     _column_starts: List[int]
     _columns: List[str]
     _rows: List[List[str]]
     _max_sizes: List[int]
+    _indent: str
 
     def _reset_state(self):
         self._state = TableParser.State.AWAITS
         self._column_starts = []
         self._columns = []
         self._rows = []
         self._max_sizes = []
+        self._indent = ''
 
     def can_parse(self, line: str) -> bool:
         return bool(re.match(self.outer_border_pattern, line))
@@ -220,6 +222,7 @@ def initiate_parsing(self, line: str, current_language: str) -> IBlockBeginning:
         self._reset_state()
         match = re.match(self.outer_border_pattern, line)
         assert match
+        self._indent = match.group(1) or ''
         self._column_starts = []
         previous = ' '
         for i, char in enumerate(line):
@@ -263,7 +266,7 @@ def _wrap(self, row: List[str], align=str.ljust) -> str:
             align(e, self._max_sizes[i])
             for i, e in enumerate(row)
         ]
-        return '| ' + (' | '.join(padded_row)) + ' |\n'
+        return self._indent + '| ' + (' | '.join(padded_row)) + ' |\n'
 
     def finish_consumption(self, final: bool) -> str:
         result = self._wrap(self._columns, align=str.center)

tests/test_rst.py

@@ -491,6 +491,45 @@ def func(): pass
 | True  | False | False   |
 """
 
+SIMPLE_TABLE_IN_PARAMS = """
+Create an array.
+Parameters
+----------
+object : array_like
+    An array, any object exposing the array interface, an object whose
+    __array__ method returns an array, or any (nested) sequence.
+order : {'K', 'A', 'C', 'F'}, optional
+    Specify the memory layout of the array.
+    If object is an array the following holds.
+    ===== ========= ===================================================
+    order  no copy                     copy=True
+    ===== ========= ===================================================
+    'K'   unchanged F & C order preserved, otherwise most similar order
+    'F'   F order   F order
+    ===== ========= ===================================================
+    When ``copy=False`` and a copy is made for other reasons...
+subok : bool, optional
+    If True, then sub-classes will be passed-through, otherwise
+"""
+
+SIMPLE_TABLE_IN_PARAMS_MARKDOWN = r"""
+Create an array.
+#### Parameters
+
+- `object`: array_like
+    An array, any object exposing the array interface, an object whose
+    \_\_array\_\_ method returns an array, or any (nested) sequence.
+- `order`: {'K', 'A', 'C', 'F'}, optional
+    Specify the memory layout of the array.
+    If object is an array the following holds.
+    | order |  no copy  |                      copy=True                      |
+    | ----- | --------- | --------------------------------------------------- |
+    | 'K'   | unchanged | F & C order preserved, otherwise most similar order |
+    | 'F'   | F order   | F order                                             |
+    When ``copy=False`` and a copy is made for other reasons...
+- `subok`: bool, optional
+    If True, then sub-classes will be passed-through, otherwise
+"""
 
 INTEGRATION = """
 Return a fixed frequency DatetimeIndex.
@@ -618,6 +657,10 @@ def func(): pass
     'converts standard simple table': {
         'rst': SIMPLE_TABLE_2,
         'md': SIMPLE_TABLE_2_MARKDOWN
+    },
+    'converts indented simple table': {
+        'rst': SIMPLE_TABLE_IN_PARAMS,
+        'md': SIMPLE_TABLE_IN_PARAMS_MARKDOWN
     }
 }