doclets: Allow overloaded functions to not conflict

sphinx_js/doclets.py

@@ -45,7 +45,9 @@ def gather_doclets(app):
                 doclet_full_path(d, root_for_relative_paths),
                 d)
         except PathTaken as conflict:
-            conflicts.append(conflict.segments)
+            # Allow overloaded functions, but not other duplicates
+            if d['kind'] != 'function':
+                conflicts.append(conflict.segments)
     if conflicts:
         raise PathsTaken(conflicts)
 

tests/test_build_ts/source/class.ts

@@ -26,4 +26,18 @@ class ClassDefinition {
     anotherMethod() {
 
     }
-}
+
+    /**
+     * This is an overloaded method (1).
+     */
+    overloaded(arg: number): number;
+
+    /**
+     * This is an overloaded method (2).
+     */
+    overloaded(arg: string): string;
+
+    overloaded(arg: number | string): number | string {
+        return arg;
+    }
+}

tests/test_build_ts/test_build_ts.py

@@ -27,3 +27,10 @@ def test_autoclass_star_order(self):
         pos_field = contents.index('ClassDefinition.field')
         pos_method2 = contents.index('ClassDefinition.anotherMethod')
         assert pos_method < pos_field < pos_method2, 'Methods and fields are not in right order in ' + contents
+
+    def test_overloads(self):
+        """Make sure overloaded methods work."""
+        contents = self._file_contents('index')
+        pos_overloaded_1 = contents.index('overloaded method (1)')
+        pos_overloaded_2 = contents.index('overloaded method (2)')
+        assert pos_overloaded_1 < pos_overloaded_2, 'Method overloads are not in right order in ' + contents