Sphinx API documentation for Javascript

Question

I am using Sphinx extensively for documentation and feel comfortable with it.

However, more more I found myself doing Javascript (front-end) than Python.

Are there any plug-ins or ways to do similar API documentation from JavaScript code comments with Sphinx as there is with Python docstrings?

Answer 1

I had the same problem, so I wrote sphinx-js to address it. It's basically autodoc for JavaScript, with a few other niceties. There's a more in-depth writeup over at the Mozilla Hacks blog. Advantages over similar packages are better polish, no Java dependency, standard JSDoc syntax in your source, and an autodoc-esque rather than an include-based workflow.