admin管理员组

文章数量:1324799

I am using Sphinx extensively for documentation and feel fortable 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 ments with Sphinx as there is with Python docstrings?

I am using Sphinx extensively for documentation and feel fortable 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 ments with Sphinx as there is with Python docstrings?

  • javascript
  • python-sphinx
Share Improve this question edited Sep 16, 2012 at 10:49 Juho Vepsäläinen 26.9k13 gold badges82 silver badges108 bronze badges asked Sep 16, 2012 at 10:27 Mikko OhtamaaMikko Ohtamaa 83.7k60 gold badges287 silver badges468 bronze badges 2
  • You might be interested in this thread on the sphinx mailinglist: groups.google./forum/?fromgroups#!topic/sphinx-dev/… – Markus Unterwaditzer Commented Sep 16, 2012 at 11:00
  • Similar question: stackoverflow./q/8644751/407651. – mzjn Commented Sep 16, 2012 at 12:03
Add a ment  | 

2 Answers 2

Reset to default 9

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.

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

本文标签： Sphinx API documentation for JavascriptStack Overflow

版权声明：本文标题：Sphinx API documentation for Javascript - Stack Overflow 内容由网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://www.betaflare.com/web/1742137106a2422418.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。