JS-Doc-Toolkit RST-Template Documentation
JS-Doc-Toolkit RST-Template Documentation
Release 0.1
Juha Mustonen
April 21, 2016
Contents
1 Installation
3
2 Usage
5
2.1 Comment your code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 Generate API documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 Write documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3 Examples
7
3.1 API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4 License: MIT
11
4.1 Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
i
ii
JS-Doc-Toolkit RST-Template Documentation, Release 0.1
Project provides a RST (ReStructuredText) compliant templates for JsDoc Toolkit documentation generator, making it easy to document project's JavaScript resources with Sphinx. With the custom rst -template, it is possible to generate rst-document pages using JsDoc Toolkit. From there, the generated pages can be included as part of documentation, similar to Sphinx autogen feature. The process is shown in the illustration:
Contents
1
................
................
In order to avoid copyright disputes, this page is only a partial summary.
To fulfill the demand for quickly locating and searching documents.
It is intelligent file search solution for home and business.
Related download
- esc 101 fundamentals of computing end semester
- function aliases extended inheritance opaque typedefs
- bessel functions of the first and second kind
- lecture 14 generic data structures
- the basics of c programming university of connecticut
- bindows documenting code
- jsdoc template typedef
- user defined data types in rhapsody
- structures princeton university
- systemverilog is getting even better
Related searches
- financial aid toolkit ed fafsa
- mental health awareness toolkit 2019
- parent toolkit app
- knowledge management toolkit pdf
- professional cv template doc word
- parent toolkit neda
- business process documentation template excel
- microsoft toolkit for windows 10 64 bit
- windows performance toolkit windows 10
- windows performance toolkit download 10
- non profit job description toolkit bridgespan
- microsoft toolkit windows 10 download free