Skip to content

JSDoc to ReST documentation, ready to be processed by Sphinx Doc

License

Notifications You must be signed in to change notification settings

HumanBrainProject/jsdoc-sphinx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

License

Licensed under The MIT License (MIT)

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

About

JSDoc to ReST documentation, ready to be processed by Sphinx Doc

Resources

License

Stars

Watchers

Forks

Packages

No packages published