Labs/Bespin/DesignDocs/Inline Documentation/Documentation Systems: Difference between revisions

Latest revision as of 00:47, 23 May 2009

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.

Python Docs (According to About : based on Sphynx)
- Great Search features
  - Even when statically served
Code Illumination (Blog Intro | Google Code | Used for Bespin)
- Great layout
- No build step (Love that!)

IMHO of course.

@@ Line 1: / Line 1: @@
+==Overview==
 This page includes a list of documentation systems that we will use for reference when building our own documentation systems.
-*[http://docs.python.org/ Python Docs] ([http://docs.python.org/about.html About Documentation])
+PLEASE add other systems for reference to the list below.
-**Based on [http://sphinx.pocoo.org/ Sphynx]
+==Systems to reference==
+===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 ]