Labs/Bespin/DesignDocs/Inline Documentation/Documentation Systems: Difference between revisions
< Labs | Bespin | DesignDocs | Inline Documentation
Jump to navigation
Jump to search
mNo edit summary |
m (→Good) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Overview== | ==Overview== | ||
This page includes a list of documentation systems that we will use for reference when building our own documentation systems. | This page includes a list of documentation systems that we will use for reference when building our own documentation systems. | ||
PLEASE add other systems for reference to the list below. | |||
==Systems to reference== | ==Systems to reference== | ||
*[http://docs.python.org/ Python Docs] ([http://docs.python.org/about.html About | ===Good=== | ||
*[http://docs.python.org/ Python Docs] (According to [http://docs.python.org/about.html About ]: based on [http://sphinx.pocoo.org/ Sphynx]) | |||
**Great Search features | |||
***Even when statically served | |||
*[https://bespin.mozilla.com/docs/ Code Illumination] ([http://www.toolness.com/wp/?p=441 Blog Intro] | [http://code.google.com/p/code-illuminated/ Google Code] | [https://bespin.mozilla.com/docs/ Used for Bespin]) | |||
**Great layout | |||
**No build step (Love that!) | |||
===Not so good=== | |||
IMHO of course. | |||
*[http://rdoc.sourceforge.net/doc/index.html RDoc ] | |||
Latest revision as of 00:47, 23 May 2009
Overview
This page includes a list of documentation systems that we will use for reference when building our own documentation systems.
PLEASE add other systems for reference to the list below.
Systems to reference
Good
- Python Docs (According to About : based on Sphynx)
- Great Search features
- Even when statically served
- Great Search features
- Code Illumination (Blog Intro | Google Code | Used for Bespin)
- Great layout
- No build step (Love that!)
Not so good
IMHO of course.