Implement inline-block math parsing

Author: krassowski

docstring_to_markdown/rst.py

@@ -50,9 +50,12 @@ def __init__(self, pattern: str, replacement: str, name: Union[str, None] = None
     ),
     Directive(
         pattern=r':math:`(?P<latex>[^`]+?)`',
-        # this will give $latex$, the second dollar is an escape character
         replacement=r'$\g<latex>$'
     ),
+    Directive(
+        pattern=r'\.\. math:: (?P<latex>[^`]+?)(?P<end>$|\n)',
+        replacement=r'$$\g<latex>$$\g<end>'
+    ),
     Directive(
         pattern=r'\.\. highlight:: (?P<language>.+)(?P<end>$|\n)',
         replacement=r'',

setup.cfg

@@ -35,7 +35,7 @@ docstring-to-markdown = py.typed
 addopts =
     --pyargs tests
     --cov docstring_to_markdown
-    --cov-fail-under=97
+    --cov-fail-under=97.5
     --cov-report term-missing:skip-covered
     -p no:warnings
     --flake8

tests/test_rst.py

@@ -275,6 +275,22 @@ def func(): pass
 which extends in the obvious way to higher dimensions, and the inverses
 """
 
+MATH_INLINE_BLOCK = """
+covariance matrix, `C`, is
+
+.. math:: R_{ij} = \\frac{ C_{ij} } { \\sqrt{ C_{ii} * C_{jj} } }
+
+The values of `R` are between -1 and 1, inclusive.
+"""
+
+MATH_INLINE_BLOCK_MARKDOWN = """
+covariance matrix, `C`, is
+
+$$R_{ij} = \\frac{ C_{ij} } { \\sqrt{ C_{ii} * C_{jj} } }$$
+
+The values of `R` are between -1 and 1, inclusive.
+"""
+
 KWARGS_PARAMETERS = """
 Parameters
 ----------
@@ -451,6 +467,10 @@ def func(): pass
         'rst': RST_MATH_EXAMPLE,
         'md': RST_MATH_EXAMPLE_MARKDOWN
     },
+    'converts inline-block math': {
+        'rst': MATH_INLINE_BLOCK,
+        'md': MATH_INLINE_BLOCK_MARKDOWN
+    },
     'converts references': {
         'rst': RST_REF_EXAMPLE,
         'md': RST_REF_MARKDOWN
@@ -499,7 +519,7 @@ def func(): pass
         'rst': WARNING_BLOCK,
         'md': WARNING_BLOCK_MARKDOWN
     },
-    'converts single-line warnings': {
+    'converts inline-block warnings': {
         'rst': LINE_WARNING,
         'md': LINE_WARNING_MARKDOWN
     },