Changeset 9373:b0c094cad1f4 in orange


Ignore:
Timestamp:
12/16/11 15:56:07 (2 years ago)
Author:
mitar
Branch:
default
Convert:
0ff6b3c8140ff34113d08764b07cbc9ef8094963
Message:

Updating reference documentation's documentation to current status.

Location:
docs/reference
Files:
1 added
2 deleted
1 edited

Legend:

Unmodified
Added
Removed
  • docs/reference/README.txt

    r9372 r9373  
    33 
    44The documentation can be built with Sphinx 1.0 or newer. Download it at 
    5 http://sphinx.pocoo.org/. Also, Orange needs to be installed to build 
    6 the documentation. To build the documentation, run 
     5http://sphinx.pocoo.org/. Also, Orange needs to be installed to build the 
     6documentation. And numpydoc Sphinx extension. To build the documentation, run 
    77 
    88    make html 
    99 
    10 which will create a directory "html" containing the documentation. If  
    11 make is not installed on your machine, run 
     10which will create a directory "html" containing the documentation. If make is 
     11not installed on your machine, run 
    1212 
    1313    sphinx-build -b html rst html 
    1414 
    15 in orange/doc/Orange. The last two parameters are the input and output  
    16 directory. 
    17  
    18 For the links to code to work, copy the rst/code directory into 
    19 html directory. 
     15in docs/reference. The last two parameters are the input and output directory. 
    2016 
    2117Structure 
    2218========= 
    2319 
    24 The actual documentation is intermixed in orange/doc/Orange/rst  
    25 and scripts in orange/Orange.  
     20The actual documentation is intermixed from docs/reference/rst and documented 
     21Python modules in orange/Orange.  
    2622 
    27 Regression testing and scripts are in orange/Orange/rst/code. Additional 
    28 files, such as images, go into orange/Orange/rst/files. 
     23Regression testing and scripts are in docs/reference/rst/code. Additional 
     24files, such as images, are in docs/reference/rst/files. 
Note: See TracChangeset for help on using the changeset viewer.