Changes between Version 7 and Version 8 of Documentation


Ignore:
Timestamp:
01/26/12 17:31:56 (3 years ago)
Author:
mitar
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Documentation

    v7 v8  
    33Write Orange documentation according to [https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt NumPy / SciPy documentation style guide]. We now use NumPy Sphinx extension to format the rst documentation. Do not forget to install numpydoc (easy_install numpydoc) as described in the [https://github.com/numpy/numpy/blob/master/doc/HOWTO_BUILD_DOCS.rst.txt Building the NumPy API and reference docs]. 
    44 
    5 The documentation is on the SVN (source:trunk/), in [source:trunk/orange/doc/Orange/ orange/doc/Orange]. 
    6 It can be compiled with [http://sphinx.pocoo.org/ Sphinx]. Compiled documentation can be found [//doc/orange25/ here] (still work in progress). Please also refer to the [//doc/ current documentation]. 
     5The documentation is in the repository ([source:]), in [source:docs/reference/ docs/reference/]. 
     6It can be compiled with [http://sphinx.pocoo.org/ Sphinx]. Compiled documentation can be found [//doc/reference/ here]. 
    77 
    8 See [source:trunk/orange/doc/Orange/README.txt README.txt]  
     8See [source:docs/reference/README.txt README.txt]  
    99in that directory for building instructions. 
    1010 
    11 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. 
     11The actual documentation is intermixed in docs/reference/rst and scripts in orange/Orange. Regression testing and scripts are in docs/reference/rst/code. Additional files, such as images, go into docs/reference/rst/files. 
    1212 
    1313=== Tips and Tricks ===