Typescript doclet order and generic types

mozilla / sphinx-js

Autodoc-style extraction into Sphinx for your JS project

https://pypi.python.org/pypi/sphinx-js/

MIT License

282 stars 81 forks source link

Typescript doclet order and generic types #99

Closed graup closed 5 years ago

graup commented 5 years ago

This is a fix for #98. It builds on top of #92 (should be merged first). This works by recursively calling make_type_name when we have typeArguments.

This PR additionally changes the order of fields (they should come before methods) by using the longname for sorting instead of just the name.

I also added a build test for typescript.

Let's merge #92 first and then review this PR separately.

graup commented 5 years ago

I rebased this on the current master and cleaned up the commit history.

Summary of changes:

renderer: use longname to sort, if available
add a typescript build test to test the order of doclets in the rendered output
doclet generator: support type arguments
add ts->jsdoc tests for complex type arguments

graup commented 5 years ago

@erikrose Here's a gentle reminder to look at this PR when you've got some time. Thanks.