ServerJS/Doctools: Difference between revisions
< ServerJS
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
* 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://code.google.com/p/code-illuminated/ Code Illumionated] uses an approach with nice typography to document code. | |||
* [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. | * [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. | ||
Latest revision as of 16:13, 6 February 2009
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 doc, was generated with ejsmod.
- http://scriptdoc.org/ (no public tooling)
- http://www.naturaldocs.org/ (requires Perl)
- Code Illumionated uses an approach with nice typography to document code.
- Sphinx is a Python-based tool for building documentation packages based on ReStructured Text files. It can generate HTML and PDF. Paver has support for Sphinx to be able to maintain example code separate from the documentation files.