dcsimg

Mozilla Debuts Sphinx-js for JavaScript Documentation

By HTMLGoodies Staff

WEBINAR:
On-Demand

Application Security Testing: An Integral Part of DevOps


Firefox maker Mozilla has launched a new open source JavaScript tool called sphinx-js. Intended as an alternative for and complement to JSDoc, sphinx-js brings the capabilities of the Sphinx Python documentation project to JavaScript.

The sphinx-js website explains that the tool is especially well-suited to large JavaScript projects. "When you write a JavaScript library, how do you explain it to people? If it’s a small project in a domain your users are familiar with, JSDoc’s alphabetical list of routines might suffice. But in a larger project, it is useful to intersperse prose with your API docs without having to copy and paste things,” the website says. “sphinx-js lets you use the industry-leading Sphinx documentation tool with JS projects. It provides a handful of directives, patterned after the Python-centric autodoc ones, for pulling JSDoc-formatted documentation into reStructuredText pages. And, because you can keep using JSDoc in your code, you remain compatible with the rest of your JS tooling, like Google’s Closure Compiler.”

View article



Make a Comment

Loading Comments...

  • Web Development Newsletter Signup

    Invalid email
    You have successfuly registered to our newsletter.

    By submitting your information, you agree that htmlgoodies.com may send you HTMLGOODIES offers via email, phone and text message, as well as email offers about other products and services that HTMLGOODIES believes may be of interest to you. HTMLGOODIES will process your information in accordance with the Quinstreet Privacy Policy.

  •  
  •  
  •  
Thanks for your registration, follow us on our social networks to keep up-to-date