Merge in master to get ReST escaping...

erikrose · erikrose · commit 0600fa73fe3f · 2018-04-16T10:51:01.000-04:00
...which I suspect I need to make the `\"` in my new tests come out right.
diff --git a/sphinx_js/renderers.py b/sphinx_js/renderers.py
@@ -8,6 +8,7 @@
 from jinja2 import Environment, PackageLoader
 from six import iteritems
 from sphinx.errors import SphinxError
+from sphinx.util import rst
 
 from .parsers import PathVisitor
 from .suffix_tree import SuffixAmbiguous, SuffixNotFound
@@ -273,7 +274,7 @@ def _params_formatter(field, description):
     types = _or_types(field)
     if types:
         heads.append(types)
-    heads.append(field['name'])
+    heads.append(rst.escape(field['name']))
     tail = description
     return heads, tail
 
@@ -290,8 +291,12 @@ def _exceptions_formatter(field, description):
 
 def _or_types(field):
     """Return all the types in a doclet subfield like "params" or "returns"
-    with vertical bars between them, like "number|string"."""
-    return '|'.join(field.get('type', {}).get('names', []))
+    with vertical bars between them, like "number|string".
+
+    ReST-escape the types.
+
+    """
+    return rst.escape('|'.join(field.get('type', {}).get('names', [])))
 
 
 def _dotted_path(segments):
diff --git a/tests/test_build/source/code.js b/tests/test_build/source/code.js
@@ -158,3 +158,10 @@ function destructuredParams(p1, {foo, bar}) {}
  * @param [e]
  */
 function defaultValues(a, b, c="true", d=true, e=null) {}
+
+/**
+ * @param a_
+ * @param {type_} b
+ * @returns {rtype_}
+ */
+function injection() {}
diff --git a/tests/test_build/source/docs/injection.rst b/tests/test_build/source/docs/injection.rst
@@ -0,0 +1 @@
+.. js:autofunction:: injection
diff --git a/tests/test_build/test_build.py b/tests/test_build/test_build.py
@@ -177,6 +177,18 @@ def test_no_shadowing(self):
             'avoid_shadowing',
             'more_code.shadow()\n\n   Another thing named shadow, to threaten to shadow the one in\n   code.js\n')
 
+    def test_restructuredtext_injection(self):
+        """Make sure param names and types are escaped and cannot be
+        interpreted as RestructuredText."""
+        self._file_contents_eq(
+            'injection',
+            u'injection(a_, b)\n\n'
+            '   Arguments:\n'
+            '      * **a_** --\n\n'
+            '      * **b** (*type_*) --\n\n'
+            '   Returns:\n'
+            '      **rtype_** --\n')
+
 
 DESCRIPTION = """
 
