@indiscale/jsdoc-sphinx

JSDoc Sphinx Template

Forked from https://github.com/HumanBrainProject/jsdoc-sphinx to fix an incompatibility with a dependency. We don't plan on maintaining this any further than making it compatible with our documentation setup.

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

• https://jsdoc.app/

License

Licensed under The MIT License (MIT)

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