Submitted by covingto on Fri, 06/03/2011 - 22:47
We are actively working on improving the documentation of widgets in Red-R. To make this easier for developers and users alike, we have begun to use the to make both developer and user documentation within the widget.py files. Doing this should greatly improve the documentation as even the default documentation may be sufficient to help the user, and entering documentation for the user by the developer should be much easier.
To do this, we have developed several key directives to be used. While these are in the form of docutils directives, they are parsed specifically by our parser to be included in the document.
These directives include .. rrgui::, .. rrsignal::, and .. helpdoc::. We are documenting their use in another entry for core developers but developers are directed to the readFiles.py widget in base on the trunk branch to see how these work out in practice.
The RedRCaret package was used to develop the documentation procedures and developers are invited to run the command: python createPackageDoc.py ../libraries/RedRCaret
This will generate a documentation file in the help/build directory of RedRCaret opening index.html in a web browser to see the documentation.