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?

You might be interested in this thread on the sphinx mailinglist: groups.google.com/forum/?fromgroups#!topic/sphinx-dev/… — Markus Unterwaditzer
– Markus Unterwaditzer, Commented Sep 16, 2012 at 11:00

Erik Rose · Accepted Answer · 2017-07-18 15:18:39Z

10

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.

answered Jul 18, 2017 at 15:18

Erik Rose

1612 silver badges4 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Juho Vepsäläinen · Accepted Answer · 2012-09-16 10:51:36Z

0

You might want to check out jsdoc-for-sphinx. I haven't tried it so no idea how well that works.

answered Sep 16, 2012 at 10:51

Juho Vepsäläinen

27k13 gold badges83 silver badges109 bronze badges

Collectives™ on Stack Overflow

Sphinx API documentation for Javascript

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related