* [http://people.ee.ethz.ch/~creller/web/tricks/reST.html Tricks (good!)] * [http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt Cheatsheet] * [http://sphinx.pocoo.org/markup/index.html Sphinx Markup Constructs] (Sphinx adds a lot of new directives and interpreted text roles to standard reST markup) * [wiki:WikiRestructuredText reStructuredText Support in Trac] == Examples == Add list of base classes {{{ .. autoclass:: Orange.network.Network :members: :show-inheritance: }}} Hyperlink inside documentation text: {{{ name of the link _ see :doc:Orange.data.formats }}} References to objects within the same documentation page: {{{ Calls methods for :obj:Solver for training. }}} Indexing: {{{ .. index:: naive Bayes classifier, k-nearest neighbors .. index:: single: classification; support vector machines (SVM) .. index:: pair: sorting; bubble }}} Admonitions (attention, caution, danger, error, hint, important, note, tip, warning): {{{ .. note:: Python list indexes start with 0! }}} [http://www.siafoo.net/help/math Latex equations], inline or stand-alone: {{{ A famous formula :math:E=mc^2 is faulty! See: .. math:: \nabla \cdot E = \frac{1}{\epsilon_0} \rho }}} Code: {{{ .. literalinclude:: code/kmeans-silhouette.py .. literalinclude:: code/example.py :lines: 1,3,5-10,20- }}} Titles not appearing in the table of contents: {{{ .. rubric:: Examples }}} Images: {{{ .. image:: python_win.* :alt: Orange in PythonWin }}} Exclude methods: {{{ .. autoclass:: Orange.network.NetworkOptimization :members: :exclude-members: collapse }}} References and citations: {{{ .. [Breiman1984] L Breiman et al: Classification and Regression Trees, Chapman and Hall, 1984. """For description of MDL see [Kononenko1995]_.""" }}}