npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jsdoc-sphinx

v0.0.6

Published

A JSDoc3 template which output ReStructured Text for Sphinx Doc

Downloads

34

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

oliamboliamb

Keywords

jsdocjsdoc3templaterstrestructuredtextsphinxjavascriptdocumentationgenerator

Readme

JSDoc Sphinx Template

Generate ReStructured Text from JSDoc3 API documentation that can be further processed by Sphinx.

Use this template to generate Restructured Text from you JSDoc comments.

The generated documentation can then be processed by Sphinx.

Getting Started

Use NPM to install JSDoc3 and this template.

npm install jsdoc
npm install jsdoc-sphinx

Assuming your are in your project root folder, you can then generate the documentation using:

jsdoc -t node_modules/jsdoc-sphinx/template -d OUTPUT_DIR JS_SOURCE_DIR/FILE

Reference

  • http://usejsdoc.org/

License

Licensed under The MIT License (MIT)

For the full copyright and license information, please view the LICENSE.txt file.