wiki:Documentation

Version 4 (modified by marko, 3 years ago) (diff)

Location of the documentation

The documentation is on the SVN (source:trunk/), in orange/doc/Orange. It can be compiled with  Sphinx. Compiled version of the documentation, which is easier to read, can be found here. This documentation is new and is still in progress. Please refer also to current documentation on Orange site.

See README.txt in that directory for instructions.

The actual documentation is intermixed in orange/doc/Orange/rst and scripts in orange/Orange. Regression testing and scripts are in orange/Orange/rst/code. Additional files, such as images, go into orange/Orange/rst/files.

Tips and Tricks

  • help with ReStructuredText
  • When manually describing a C++ class, use the .. py:class:: instead of .. class:: if you need to describe the parameters taken by the constructor. For example, this works as intended:
    .. py:class:: Orange.classification.rules.RuleLearner(storeExamples = true, targetClass = -1, baseRules = Orange.classification.rules.RuleList())