Add missing Sphinx cross-references

Author: krassowski

docstring_to_markdown/rst.py

@@ -12,9 +12,100 @@ def __init__(self, pattern: str, replacement: str, name: Union[str, None] = None
         self.name = name
 
 
+# https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-python-objects
+SPHINX_CROSS_REF_PYTHON = (
+    'mod',
+    'func',
+    'data',
+    'const',
+    'class',
+    'meth',
+    'attr',
+    'exc',
+    'obj'
+)
+
+# https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-c-constructs
+SPHINX_CROSS_REF_C = (
+    'member',
+    'data',
+    'func',
+    'macro',
+    'struct',
+    'union',
+    'enum',
+    'enumerator',
+    'type'
+)
+
+# https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing
+SPHINX_CROSS_REF_CPP = (
+    'any',
+    'class',
+    'struct',
+    'func',
+    'member',
+    'var',
+    'type',
+    'concept',
+    'enum',
+    'enumerator'
+)
+
+# https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-javascript-domain
+SPHINX_CROSS_REF_JS = (
+    'mod',
+    'func',
+    'meth',
+    'class',
+    'data',
+    'attr'
+)
+
+# https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-restructuredtext-domain
+SPHINX_CROSS_REF_RST = (
+    'dir',
+    'role'
+)
+
+# https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html
+SPHINX_CROSS_REF_OTHER = (
+    'any',
+    # https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-other-items-of-interest
+    'envvar',
+    'token',
+    'keyword',
+    'option',
+    'term',
+)
+
 SPHINX_RULES: List[Directive] = [
     Directive(
-        pattern=r':(func|meth|class|obj|term):`\.?(?P<name>[^`]+?)`',
+        pattern=r':c:({}):`\.?(?P<name>[^`]+?)`'.format('|'.join(SPHINX_CROSS_REF_C)),
+        replacement=r'`\g<name>`'
+    ),
+    Directive(
+        pattern=r':c:({}):`\.?(?P<name>[^`]+?)`'.format('|'.join(SPHINX_CROSS_REF_C)),
+        replacement=r'`\g<name>`'
+    ),
+    Directive(
+        pattern=r':cpp:({}):`\.?(?P<name>[^`]+?)`'.format('|'.join(SPHINX_CROSS_REF_CPP)),
+        replacement=r'`\g<name>`'
+    ),
+    Directive(
+        pattern=r':js:({}):`\.?(?P<name>[^`]+?)`'.format('|'.join(SPHINX_CROSS_REF_JS)),
+        replacement=r'`\g<name>`'
+    ),
+    Directive(
+        pattern=r'(:py)?:({}):`\.?(?P<name>[^`]+?)`'.format('|'.join(SPHINX_CROSS_REF_PYTHON)),
+        replacement=r'`\g<name>`'
+    ),
+    Directive(
+        pattern=r'(:rst)?:({}):`\.?(?P<name>[^`]+?)`'.format('|'.join(SPHINX_CROSS_REF_RST)),
+        replacement=r'`\g<name>`'
+    ),
+    Directive(
+        pattern=r':({}):`\.?(?P<name>[^`]+?)`'.format('|'.join(SPHINX_CROSS_REF_OTHER)),
         replacement=r'`\g<name>`'
     ),
     Directive(

tests/test_rst.py

@@ -715,10 +715,26 @@ def func(): pass
         'rst': REFERENCES,
         'md': REFERENCES_MARKDOWN
     },
-    'converts sphinx func, meth, and class': {
+    'converts sphinx cross-references to func, meth, class, etc.': {
         'rst': ':func:`function1`, :meth:`.Script.inline`, :class:`.Environment`',
         'md': '`function1`, `Script.inline`, `Environment`'
     },
+    'converts sphinx cross-references in Python domain': {
+        'rst': ':py:func:`function1`, :py:meth:`.Script.inline`, :py:class:`.Environment`',
+        'md': '`function1`, `Script.inline`, `Environment`'
+    },
+    'converts sphinx cross-references in C domain': {
+        'rst': ':c:func:`function1`, :c:struct:`Data`',
+        'md': '`function1`, `Data`'
+    },
+    'converts sphinx cross-references in C++ domain': {
+        'rst': ':cpp:func:`function1`, :cpp:var:`data`',
+        'md': '`function1`, `data`'
+    },
+    'converts sphinx cross-references in JS domain': {
+        'rst': ':js:func:`function1`, :js:class:`Math`',
+        'md': '`function1`, `Math`'
+    },
     'converts sphinx params': {
         'rst': ':param x: test arg',
         'md': '- `x`: test arg'