source: orange/docs/reference/README.txt @ 9373:b0c094cad1f4

Revision 9373:b0c094cad1f4, 752 bytes checked in by mitar, 2 years ago (diff)

Updating reference documentation's documentation to current status.

Line 
1Building
2========
3
4The documentation can be built with Sphinx 1.0 or newer. Download it at
5http://sphinx.pocoo.org/. Also, Orange needs to be installed to build the
6documentation. And numpydoc Sphinx extension. To build the documentation, run
7
8    make html
9
10which will create a directory "html" containing the documentation. If make is
11not installed on your machine, run
12
13    sphinx-build -b html rst html
14
15in docs/reference. The last two parameters are the input and output directory.
16
17Structure
18=========
19
20The actual documentation is intermixed from docs/reference/rst and documented
21Python modules in orange/Orange.
22
23Regression testing and scripts are in docs/reference/rst/code. Additional
24files, such as images, are in docs/reference/rst/files.
Note: See TracBrowser for help on using the repository browser.