source: orange-bioinformatics/docs/rst/index.rst @ 1736:b3b664abcfdd

Revision 1736:b3b664abcfdd, 1.4 KB checked in by Ales Erjavec <ales.erjavec@…>, 13 months ago (diff)

Added sphinx rst documentation for obiKEGG.

Line 
1Orange Bioinformatics documentation
2===================================
3
4Orange Bioinformatics is an add-on for Orange_ data mining software package. It
5extends Orange by providing common functionality for basic tasks in
6bioinformatics. It also provides widgets for Orange Canvas, which enable users
7who are not programmers to manage microarray and genomic data flow and to
8customize their analysis by combining common data analysis tools to fit their
9needs.
10
11.. _Orange: http://orange.biolab.si/
12
13Widgets
14-------
15
16.. toctree::
17   :maxdepth: 1
18 
19   PIPA.rst
20
21Scripting Reference
22-------------------
23   
24.. toctree::
25   :maxdepth: 1
26
27   reference/kegg.rst
28
29Installation
30------------
31
32To install Bioinformatics add-on for Orange from PyPi_ run::
33
34    pip install Orange-Bioinformatics
35
36To install it from source code run::
37
38    python setup.py install
39
40To build Python egg run::
41
42    python setup.py bdist_egg
43
44To install add-on in `development mode`_ run::
45
46    python setup.py develop
47
48.. _development mode: http://packages.python.org/distribute/setuptools.html#development-mode
49.. _PyPi: http://pypi.python.org/pypi
50
51Source Code and Issue Tracker
52-----------------------------
53
54Source code is available on Bitbucket_. For issues and wiki we use Trac_.
55
56.. _Bitbucket: https://bitbucket.org/biolab/orange-bioinformatics
57.. _Trac: http://orange.biolab.si/trac/
58
59Indices and tables
60==================
61
62* :ref:`genindex`
63* :ref:`modindex`
64* :ref:`search`
Note: See TracBrowser for help on using the repository browser.