orange-network / docs /

Filename Size Date modified Message
..
rst
3.1 KB
599 B
Building
========

The documentation can be built with Sphinx 1.0 or newer. Download it at
http://sphinx.pocoo.org/. Orange, numpy and numpydoc Sphinx extension needs to 
be installed. To build the documentation, run

    make html

which will create a directory "html" containing the documentation. If make is
not installed on your machine, run

    sphinx-build -b html rst html

in docs. The last two parameters are the input and output directory.

Structure
=========

The actual documentation is intermixed from docs/rst and documented Python 
modules in mm. 

Example scripts are in examples.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.