canmove, Confirmed users, Bureaucrats and Sysops emeriti
1,093
edits
ServerJS/Doctools: Difference between revisions
Jump to navigation
Jump to search
no edit summary
(New page: * http://code.google.com/p/jsdoc-toolkit/ (requires Java) * Ejscript has a javadoc style doc generator called ejsmod. This [http://www.ejscript.org/products/ejs/doc/api/gen/ejscript/inde...) |
No edit summary |
||
| Line 1: | Line 1: | ||
* | = Documentation Tools = | ||
A major output of ServerJS will be an API specification and possibly some user docs to help people get started with a ServerJS-compatible platform. | |||
== Prior Art == | |||
* http://code.google.com/p/jsdoc-toolkit/ (requires Java) | |||
* Ejscript has a javadoc style doc generator called ejsmod. This [http://www.ejscript.org/products/ejs/doc/api/gen/ejscript/index.html doc], was generated with ejsmod. | * Ejscript has a javadoc style doc generator called ejsmod. This [http://www.ejscript.org/products/ejs/doc/api/gen/ejscript/index.html doc], was generated with ejsmod. | ||
* http://scriptdoc.org/ (no public tooling) | * http://scriptdoc.org/ (no public tooling) | ||
* http://www.naturaldocs.org/ (requires Perl) | * http://www.naturaldocs.org/ (requires Perl) | ||
* [http://sphinx.pocoo.org/ Sphinx] is a Python-based tool for building documentation packages based on ReStructured Text files. It can generate HTML and PDF. [http://www.blueskyonmars.com/projects/paver/ Paver] has support for Sphinx to be able to maintain example code separate from the documentation files. | |||