Changeset 11028:009ba5a75e30 in orange


Ignore:
Timestamp:
11/14/12 13:09:26 (18 months ago)
Author:
Miha Stajdohar <miha.stajdohar@…>
Branch:
default
rebase_source:
e93acb1373615b75d8bff7e0f362efc20e6ea83f
Message:

Added a common documentation index.

Files:
4 added
1 deleted
13 edited

Legend:

Unmodified
Added
Removed
  • Orange/regression/tree.py

    r10395 r11028  
    2929================= 
    3030 
    31 .. include:: /SimpleTreeLearner.txt 
     31.. include:: SimpleTreeLearner.txt 
    3232 
    3333A basic example of using a SimpleTreeLearner is shown below: 
  • docs/development/rst/conf.py

    r10881 r11028  
    1212# serve to show the default. 
    1313 
    14 import sys, os 
     14import os, sys 
    1515 
    16 import imp 
    17 module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', '..', '..', 'setup.py')) 
    18 VERSION = module_setup.VERSION 
     16sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))) 
    1917 
    20 # If extensions (or modules to document with autodoc) are in another directory, 
    21 # add these directories to sys.path here. If the directory is relative to the 
    22 # documentation root, use os.path.abspath to make it absolute, like shown here. 
    23 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../'))) 
    24 import Orange 
     18from conf import * 
    2519 
    26 # -- General configuration ----------------------------------------------------- 
     20TITLE = "%s v%s" % ("Orange Library Development", VERSION) 
    2721 
    28 # Add any Sphinx extension module names here, as strings. They can be extensions 
    29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    30 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.pngmath'] 
     22html_title = TITLE 
     23epub_title = TITLE 
    3124 
    32 # Add any paths that contain templates here, relative to this directory. 
    33 templates_path = ['_templates'] 
    34  
    35 # The suffix of source filenames. 
    36 source_suffix = '.rst' 
    37  
    38 # The encoding of source files. 
    39 #source_encoding = 'utf-8' 
    40  
    41 # The master toctree document. 
    42 master_doc = 'index' 
    43  
    44 # General information about the project. 
    45 project = u'Orange' 
    46 copyright = u'Bioinformatics Laboratory, FRI UL' 
    47  
    48 # The version info for the project you're documenting, acts as replacement for 
    49 # |version| and |release|, also used in various other places throughout the 
    50 # built documents. 
    51 # 
    52 # The short X.Y version. 
    53 version = VERSION 
    54 # The full version, including alpha/beta/rc tags. 
    55 release = VERSION 
    56  
    57 # The language for content autogenerated by Sphinx. Refer to documentation 
    58 # for a list of supported languages. 
    59 #language = None 
    60  
    61 # There are two options for replacing |today|: either, you set today to some 
    62 # non-false value, then it is used: 
    63 #today = '' 
    64 # Else, today_fmt is used as the format for a strftime call. 
    65 #today_fmt = '%B %d, %Y' 
    66  
    67 # List of documents that shouldn't be included in the build. 
    68 #unused_docs = [] 
    69  
    70 # List of directories, relative to source directory, that shouldn't be searched 
    71 # for source files. 
    72 exclude_trees = ['_build'] 
    73  
    74 # The reST default role (used for this markup: `text`) to use for all documents. 
    75 #default_role = None 
    76  
    77 # If true, '()' will be appended to :func: etc. cross-reference text. 
    78 #add_function_parentheses = True 
    79  
    80 # If true, the current module name will be prepended to all description 
    81 # unit titles (such as .. function::). 
    82 #add_module_names = True 
    83  
    84 # If true, sectionauthor and moduleauthor directives will be shown in the 
    85 # output. They are ignored by default. 
    86 #show_authors = False 
    87  
    88 # The name of the Pygments (syntax highlighting) style to use. 
    89 pygments_style = 'sphinx' 
    90  
    91 # A list of ignored prefixes for module index sorting. 
    92 #modindex_common_prefix = [] 
    93  
    94  
    95 # -- Options for HTML output --------------------------------------------------- 
    96  
    97 # The theme to use for HTML and HTML Help pages.  Major themes that come with 
    98 # Sphinx are currently 'default' and 'sphinxdoc'. 
    99 html_theme = 'orange_theme' 
    100  
    101 # Theme options are theme-specific and customize the look and feel of a theme 
    102 # further.  For a list of options available for each theme, see the 
    103 # documentation. 
    104 html_theme_options = {"collapsiblesidebar": "false"} 
    105  
    106 if html_theme == "orange_theme": 
    107     html_theme_options.update({"orangeheaderfooter": "false"}) 
    108  
    109 # Add any paths that contain custom themes here, relative to this directory. 
    110 html_theme_path = ["../../sphinx-ext/themes"] 
    111  
    112 # The name for this set of Sphinx documents.  If None, it defaults to 
    113 # "<project> v<release> documentation". 
    114 html_title = "Orange Library Development" 
    115  
    116 # A shorter title for the navigation bar.  Default is the same as html_title. 
    117 #html_short_title = None 
    118  
    119 # The name of an image file (relative to this directory) to place at the top 
    120 # of the sidebar. 
    121 #html_logo = None 
    122  
    123 # The name of an image file (within the static path) to use as favicon of the 
    124 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32 
    125 # pixels large. 
    126 #html_favicon = None 
    127  
    128 # Add any paths that contain custom static files (such as style sheets) here, 
    129 # relative to this directory. They are copied after the builtin static files, 
    130 # so a file named "default.css" will overwrite the builtin "default.css". 
    131 html_static_path = [] 
    132  
    133 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 
    134 # using the given strftime format. 
    135 #html_last_updated_fmt = '%b %d, %Y' 
    136  
    137 # If true, SmartyPants will be used to convert quotes and dashes to 
    138 # typographically correct entities. 
    139 #html_use_smartypants = True 
    140  
    141 # Custom sidebar templates, maps document names to template names. 
    142 #html_sidebars = {} 
    143  
    144 # Additional templates that should be rendered to pages, maps page names to 
    145 # template names. 
    146 #html_additional_pages = {} 
    147  
    148 # If false, no module index is generated. 
    149 #html_use_modindex = True 
    150  
    151 # If false, no index is generated. 
    152 #html_use_index = True 
    153  
    154 # If true, the index is split into individual pages for each letter. 
    155 #html_split_index = False 
    156  
    157 # If true, links to the reST sources are added to the pages. 
    158 #html_show_sourcelink = True 
    159  
    160 # If true, an OpenSearch description file will be output, and all pages will 
    161 # contain a <link> tag referring to it.  The value of this option must be the 
    162 # base URL from which the finished HTML is served. 
    163 #html_use_opensearch = '' 
    164  
    165 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 
    166 #html_file_suffix = '' 
    167  
    168 # Output file base name for HTML help builder. 
    169 htmlhelp_basename = 'developmentsdoc' 
    170  
    171  
    172 # -- Options for LaTeX output -------------------------------------------------- 
    173  
    174 # The paper size ('letter' or 'a4'). 
    175 #latex_paper_size = 'letter' 
    176  
    177 # The font size ('10pt', '11pt' or '12pt'). 
    178 #latex_font_size = '10pt' 
    179  
    180 # Grouping the document tree into LaTeX files. List of tuples 
    181 # (source start file, target name, title, author, documentclass [howto/manual]). 
    18225latex_documents = [ 
    183   ('index', 'development.tex', u'Orange Library Development', 
    184    u'Biolab', 'manual'), 
    185 ] 
    186  
    187 # The name of an image file (relative to this directory) to place at the top of 
    188 # the title page. 
    189 #latex_logo = None 
    190  
    191 # For "manual" documents, if this is true, then toplevel headings are parts, 
    192 # not chapters. 
    193 #latex_use_parts = False 
    194  
    195 # Additional stuff for the LaTeX preamble. 
    196 #latex_preamble = '' 
    197  
    198 # Documents to append as an appendix to all manuals. 
    199 #latex_appendices = [] 
    200  
    201 # If false, no module index is generated. 
    202 #latex_use_modindex = True 
    203  
    204 # -- Options for Epub output --------------------------------------------------- 
    205  
    206 # Bibliographic Dublin Core info. 
    207 epub_title = u'Orange Library Development' 
    208 epub_author = u'Biolab' 
    209 epub_publisher = u'Biolab' 
    210 epub_copyright = u'Bioinformatics Laboratory, FRI UL' 
    211  
    212 # The language of the text. It defaults to the language option 
    213 # or en if the language is not set. 
    214 epub_language = 'en' 
    215  
    216 # The scheme of the identifier. Typical schemes are ISBN or URL. 
    217 #epub_scheme = '' 
    218  
    219 # The unique identifier of the text. This can be a ISBN number 
    220 # or the project homepage. 
    221 #epub_identifier = '' 
    222  
    223 # A unique identification for the text. 
    224 #epub_uid = '' 
    225  
    226 # HTML files that should be inserted before the pages created by sphinx. 
    227 # The format is a list of tuples containing the path and title. 
    228 #epub_pre_files = [] 
    229  
    230 # HTML files that should be inserted after the pages created by sphinx. 
    231 # The format is a list of tuples containing the path and title. 
    232 #epub_post_files = [] 
    233  
    234 # A list of files that should not be packed into the epub file. 
    235 epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"] 
    236  
    237 # The depth of the table of contents in toc.ncx. 
    238 #epub_tocdepth = 3 
    239  
    240 # Allow duplicate toc entries. 
    241 #epub_tocdup = True 
    242  
    243 # Example configuration for intersphinx: refer to the Python standard library. 
    244 intersphinx_mapping = { 
    245     'python': ('http://docs.python.org/', None), 
    246     'reference': ('http://orange.biolab.si/doc/reference/', 'http://orange.biolab.si/doc/reference/_objects/'), 
    247 } 
     26    ('index', 'reference.tex', TITLE, 
     27     AUTHOR, 'manual'), 
     28    ] 
  • docs/extend-widgets/rst/conf.py

    r10881 r11028  
    1212# serve to show the default. 
    1313 
    14 import sys, os 
     14import os, sys 
    1515 
    16 import imp 
    17 module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', '..', '..', 'setup.py')) 
    18 VERSION = module_setup.VERSION 
     16sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))) 
    1917 
    20 # If extensions (or modules to document with autodoc) are in another directory, 
    21 # add these directories to sys.path here. If the directory is relative to the 
    22 # documentation root, use os.path.abspath to make it absolute, like shown here. 
    23 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../'))) 
    24 import Orange 
     18from conf import * 
    2519 
    26 # -- General configuration ----------------------------------------------------- 
     20TITLE = "%s v%s" % ("Orange Widget Development", VERSION) 
    2721 
    28 # Add any Sphinx extension module names here, as strings. They can be extensions 
    29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    30 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.pngmath'] 
     22html_title = TITLE 
     23epub_title = TITLE 
    3124 
    32 # Add any paths that contain templates here, relative to this directory. 
    33 templates_path = ['_templates'] 
     25latex_documents = [ 
     26    ('index', 'reference.tex', TITLE, 
     27     AUTHOR, 'manual'), 
     28    ] 
    3429 
    35 # The suffix of source filenames. 
    36 source_suffix = '.rst' 
    37  
    38 # The encoding of source files. 
    39 #source_encoding = 'utf-8' 
    40  
    41 # The master toctree document. 
    42 master_doc = 'index' 
    43  
    44 # General information about the project. 
    45 project = u'Orange' 
    46 copyright = u'Bioinformatics Laboratory, FRI UL' 
    47  
    48 # The version info for the project you're documenting, acts as replacement for 
    49 # |version| and |release|, also used in various other places throughout the 
    50 # built documents. 
    51 # 
    52 # The short X.Y version. 
    53 version = VERSION 
    54 # The full version, including alpha/beta/rc tags. 
    55 release = VERSION 
    56  
    57 # The language for content autogenerated by Sphinx. Refer to documentation 
    58 # for a list of supported languages. 
    59 #language = None 
    60  
    61 # There are two options for replacing |today|: either, you set today to some 
    62 # non-false value, then it is used: 
    63 #today = '' 
    64 # Else, today_fmt is used as the format for a strftime call. 
    65 #today_fmt = '%B %d, %Y' 
    66  
    67 # List of documents that shouldn't be included in the build. 
    68 #unused_docs = [] 
    69  
    70 # List of directories, relative to source directory, that shouldn't be searched 
    71 # for source files. 
    72 exclude_trees = ['_build'] 
    73  
    74 # The reST default role (used for this markup: `text`) to use for all documents. 
    75 #default_role = None 
    76  
    77 # If true, '()' will be appended to :func: etc. cross-reference text. 
    78 #add_function_parentheses = True 
    79  
    80 # If true, the current module name will be prepended to all description 
    81 # unit titles (such as .. function::). 
    82 #add_module_names = True 
    83  
    84 # If true, sectionauthor and moduleauthor directives will be shown in the 
    85 # output. They are ignored by default. 
    86 #show_authors = False 
    87  
    88 # The name of the Pygments (syntax highlighting) style to use. 
    89 pygments_style = 'sphinx' 
    90  
    91 # A list of ignored prefixes for module index sorting. 
    92 #modindex_common_prefix = [] 
    93  
    94  
    95 # -- Options for HTML output --------------------------------------------------- 
    96  
    97 # The theme to use for HTML and HTML Help pages.  Major themes that come with 
    98 # Sphinx are currently 'default' and 'sphinxdoc'. 
    99 html_theme = 'orange_theme' 
    100  
    101 # Theme options are theme-specific and customize the look and feel of a theme 
    102 # further.  For a list of options available for each theme, see the 
    103 # documentation. 
    104 html_theme_options = {"collapsiblesidebar": "false"} 
    105  
    106 if html_theme == "orange_theme": 
    107     html_theme_options.update({"orangeheaderfooter": "false"}) 
    108  
    109 # Add any paths that contain custom themes here, relative to this directory. 
    110 html_theme_path = ["../../sphinx-ext/themes"] 
    111  
    112 # The name for this set of Sphinx documents.  If None, it defaults to 
    113 # "<project> v<release> documentation". 
    114 html_title = "Orange Widgets Development" 
    115  
    116 # A shorter title for the navigation bar.  Default is the same as html_title. 
    117 #html_short_title = None 
    118  
    119 # The name of an image file (relative to this directory) to place at the top 
    120 # of the sidebar. 
    121 #html_logo = None 
    122  
    123 # The name of an image file (within the static path) to use as favicon of the 
    124 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32 
    125 # pixels large. 
    126 #html_favicon = None 
    127  
    128 # Add any paths that contain custom static files (such as style sheets) here, 
    129 # relative to this directory. They are copied after the builtin static files, 
    130 # so a file named "default.css" will overwrite the builtin "default.css". 
    131 html_static_path = [] 
    132  
    133 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 
    134 # using the given strftime format. 
    135 #html_last_updated_fmt = '%b %d, %Y' 
    136  
    137 # If true, SmartyPants will be used to convert quotes and dashes to 
    138 # typographically correct entities. 
    139 #html_use_smartypants = True 
    140  
    141 # Custom sidebar templates, maps document names to template names. 
    142 #html_sidebars = {} 
    143  
    144 # Additional templates that should be rendered to pages, maps page names to 
    145 # template names. 
    146 #html_additional_pages = {} 
    147  
    148 # If false, no module index is generated. 
    149 #html_use_modindex = True 
    150  
    151 # If false, no index is generated. 
    152 #html_use_index = True 
    153  
    154 # If true, the index is split into individual pages for each letter. 
    155 #html_split_index = False 
    156  
    157 # If true, links to the reST sources are added to the pages. 
    158 #html_show_sourcelink = True 
    159  
    160 # If true, an OpenSearch description file will be output, and all pages will 
    161 # contain a <link> tag referring to it.  The value of this option must be the 
    162 # base URL from which the finished HTML is served. 
    163 #html_use_opensearch = '' 
    164  
    165 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 
    166 #html_file_suffix = '' 
    167  
    168 # Output file base name for HTML help builder. 
    169 htmlhelp_basename = 'extendwidgetsdoc' 
    170  
    171  
    172 # -- Options for LaTeX output -------------------------------------------------- 
    173  
    174 # The paper size ('letter' or 'a4'). 
    175 #latex_paper_size = 'letter' 
    176  
    177 # The font size ('10pt', '11pt' or '12pt'). 
    178 #latex_font_size = '10pt' 
    179  
    180 # Grouping the document tree into LaTeX files. List of tuples 
    181 # (source start file, target name, title, author, documentclass [howto/manual]). 
    182 latex_documents = [ 
    183   ('index', 'extend-widgets.tex', u'Orange Widgets Development', 
    184    u'Biolab', 'manual'), 
    185 ] 
    186  
    187 # The name of an image file (relative to this directory) to place at the top of 
    188 # the title page. 
    189 #latex_logo = None 
    190  
    191 # For "manual" documents, if this is true, then toplevel headings are parts, 
    192 # not chapters. 
    193 #latex_use_parts = False 
    194  
    195 # Additional stuff for the LaTeX preamble. 
    196 #latex_preamble = '' 
    197  
    198 # Documents to append as an appendix to all manuals. 
    199 #latex_appendices = [] 
    200  
    201 # If false, no module index is generated. 
    202 #latex_use_modindex = True 
    203  
    204 # -- Options for Epub output --------------------------------------------------- 
    205  
    206 # Bibliographic Dublin Core info. 
    207 epub_title = u'Orange Widgets Development' 
    208 epub_author = u'Biolab' 
    209 epub_publisher = u'Biolab' 
    210 epub_copyright = u'Bioinformatics Laboratory, FRI UL' 
    211  
    212 # The language of the text. It defaults to the language option 
    213 # or en if the language is not set. 
    214 epub_language = 'en' 
    215  
    216 # The scheme of the identifier. Typical schemes are ISBN or URL. 
    217 #epub_scheme = '' 
    218  
    219 # The unique identifier of the text. This can be a ISBN number 
    220 # or the project homepage. 
    221 #epub_identifier = '' 
    222  
    223 # A unique identification for the text. 
    224 #epub_uid = '' 
    225  
    226 # HTML files that should be inserted before the pages created by sphinx. 
    227 # The format is a list of tuples containing the path and title. 
    228 #epub_pre_files = [] 
    229  
    230 # HTML files that should be inserted after the pages created by sphinx. 
    231 # The format is a list of tuples containing the path and title. 
    232 #epub_post_files = [] 
    233  
    234 # A list of files that should not be packed into the epub file. 
    235 epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"] 
    236  
    237 # The depth of the table of contents in toc.ncx. 
    238 #epub_tocdepth = 3 
    239  
    240 # Allow duplicate toc entries. 
    241 #epub_tocdup = True 
    242  
    243 # Example configuration for intersphinx: refer to the Python standard library. 
    244 intersphinx_mapping = { 
    245     'python': ('http://docs.python.org/', None), 
    246     'reference': ('http://orange.biolab.si/doc/reference/', 'http://orange.biolab.si/doc/reference/_objects/'), 
    247 } 
  • docs/first-steps/rst/conf.py

    r10881 r11028  
    1212# serve to show the default. 
    1313 
    14 import sys, os 
     14import os, sys 
    1515 
    16 import imp 
    17 module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', '..', '..', 'setup.py')) 
    18 VERSION = module_setup.VERSION 
     16sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))) 
    1917 
    20 # If extensions (or modules to document with autodoc) are in another directory, 
    21 # add these directories to sys.path here. If the directory is relative to the 
    22 # documentation root, use os.path.abspath to make it absolute, like shown here. 
    23 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../'))) 
    24 import Orange 
     18from conf import * 
    2519 
    26 # -- General configuration ----------------------------------------------------- 
     20TITLE = "%s v%s" % ("First Steps in Orange Canvas", VERSION) 
    2721 
    28 # Add any Sphinx extension module names here, as strings. They can be extensions 
    29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    30 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.pngmath'] 
     22html_title = TITLE 
     23epub_title = TITLE 
    3124 
    32 # Add any paths that contain templates here, relative to this directory. 
    33 templates_path = ['_templates'] 
     25latex_documents = [ 
     26    ('index', 'reference.tex', TITLE, 
     27     AUTHOR, 'manual'), 
     28    ] 
    3429 
    35 # The suffix of source filenames. 
    36 source_suffix = '.rst' 
    37  
    38 # The encoding of source files. 
    39 #source_encoding = 'utf-8' 
    40  
    41 # The master toctree document. 
    42 master_doc = 'index' 
    43  
    44 # General information about the project. 
    45 project = u'Orange' 
    46 copyright = u'Bioinformatics Laboratory, FRI UL' 
    47  
    48 # The version info for the project you're documenting, acts as replacement for 
    49 # |version| and |release|, also used in various other places throughout the 
    50 # built documents. 
    51 # 
    52 # The short X.Y version. 
    53 version = VERSION 
    54 # The full version, including alpha/beta/rc tags. 
    55 release = VERSION 
    56  
    57 # The language for content autogenerated by Sphinx. Refer to documentation 
    58 # for a list of supported languages. 
    59 #language = None 
    60  
    61 # There are two options for replacing |today|: either, you set today to some 
    62 # non-false value, then it is used: 
    63 #today = '' 
    64 # Else, today_fmt is used as the format for a strftime call. 
    65 #today_fmt = '%B %d, %Y' 
    66  
    67 # List of documents that shouldn't be included in the build. 
    68 #unused_docs = [] 
    69  
    70 # List of directories, relative to source directory, that shouldn't be searched 
    71 # for source files. 
    72 exclude_trees = ['_build'] 
    73  
    74 # The reST default role (used for this markup: `text`) to use for all documents. 
    75 #default_role = None 
    76  
    77 # If true, '()' will be appended to :func: etc. cross-reference text. 
    78 #add_function_parentheses = True 
    79  
    80 # If true, the current module name will be prepended to all description 
    81 # unit titles (such as .. function::). 
    82 #add_module_names = True 
    83  
    84 # If true, sectionauthor and moduleauthor directives will be shown in the 
    85 # output. They are ignored by default. 
    86 #show_authors = False 
    87  
    88 # The name of the Pygments (syntax highlighting) style to use. 
    89 pygments_style = 'sphinx' 
    90  
    91 # A list of ignored prefixes for module index sorting. 
    92 #modindex_common_prefix = [] 
    93  
    94  
    95 # -- Options for HTML output --------------------------------------------------- 
    96  
    97 # The theme to use for HTML and HTML Help pages.  Major themes that come with 
    98 # Sphinx are currently 'default' and 'sphinxdoc'. 
    99 html_theme = 'orange_theme' 
    100  
    101 # Theme options are theme-specific and customize the look and feel of a theme 
    102 # further.  For a list of options available for each theme, see the 
    103 # documentation. 
    104 html_theme_options = {"collapsiblesidebar": "false"} 
    105  
    106 if html_theme == "orange_theme": 
    107     html_theme_options.update({"orangeheaderfooter": "false"}) 
    108  
    109 # Add any paths that contain custom themes here, relative to this directory. 
    110 html_theme_path = ["../../sphinx-ext/themes"] 
    111  
    112 # The name for this set of Sphinx documents.  If None, it defaults to 
    113 # "<project> v<release> documentation". 
    114 html_title = "First Steps in Orange Canvas" 
    115  
    116 # A shorter title for the navigation bar.  Default is the same as html_title. 
    117 #html_short_title = None 
    118  
    119 # The name of an image file (relative to this directory) to place at the top 
    120 # of the sidebar. 
    121 #html_logo = None 
    122  
    123 # The name of an image file (within the static path) to use as favicon of the 
    124 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32 
    125 # pixels large. 
    126 #html_favicon = None 
    127  
    128 # Add any paths that contain custom static files (such as style sheets) here, 
    129 # relative to this directory. They are copied after the builtin static files, 
    130 # so a file named "default.css" will overwrite the builtin "default.css". 
    131 html_static_path = [] 
    132  
    133 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 
    134 # using the given strftime format. 
    135 #html_last_updated_fmt = '%b %d, %Y' 
    136  
    137 # If true, SmartyPants will be used to convert quotes and dashes to 
    138 # typographically correct entities. 
    139 #html_use_smartypants = True 
    140  
    141 # Custom sidebar templates, maps document names to template names. 
    142 #html_sidebars = {} 
    143  
    144 # Additional templates that should be rendered to pages, maps page names to 
    145 # template names. 
    146 #html_additional_pages = {} 
    147  
    148 # If false, no module index is generated. 
    149 #html_use_modindex = True 
    150  
    151 # If false, no index is generated. 
    152 #html_use_index = True 
    153  
    154 # If true, the index is split into individual pages for each letter. 
    155 #html_split_index = False 
    156  
    157 # If true, links to the reST sources are added to the pages. 
    158 #html_show_sourcelink = True 
    159  
    160 # If true, an OpenSearch description file will be output, and all pages will 
    161 # contain a <link> tag referring to it.  The value of this option must be the 
    162 # base URL from which the finished HTML is served. 
    163 #html_use_opensearch = '' 
    164  
    165 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 
    166 #html_file_suffix = '' 
    167  
    168 # Output file base name for HTML help builder. 
    169 htmlhelp_basename = 'firststepsdoc' 
    170  
    171  
    172 # -- Options for LaTeX output -------------------------------------------------- 
    173  
    174 # The paper size ('letter' or 'a4'). 
    175 #latex_paper_size = 'letter' 
    176  
    177 # The font size ('10pt', '11pt' or '12pt'). 
    178 #latex_font_size = '10pt' 
    179  
    180 # Grouping the document tree into LaTeX files. List of tuples 
    181 # (source start file, target name, title, author, documentclass [howto/manual]). 
    182 latex_documents = [ 
    183   ('index', 'first-steps.tex', u'First Steps', 
    184    u'Biolab', 'manual'), 
    185 ] 
    186  
    187 # The name of an image file (relative to this directory) to place at the top of 
    188 # the title page. 
    189 #latex_logo = None 
    190  
    191 # For "manual" documents, if this is true, then toplevel headings are parts, 
    192 # not chapters. 
    193 #latex_use_parts = False 
    194  
    195 # Additional stuff for the LaTeX preamble. 
    196 #latex_preamble = '' 
    197  
    198 # Documents to append as an appendix to all manuals. 
    199 #latex_appendices = [] 
    200  
    201 # If false, no module index is generated. 
    202 #latex_use_modindex = True 
    203  
    204 # -- Options for Epub output --------------------------------------------------- 
    205  
    206 # Bibliographic Dublin Core info. 
    207 epub_title = u'First Steps in Orange Canvas' 
    208 epub_author = u'Biolab' 
    209 epub_publisher = u'Biolab' 
    210 epub_copyright = u'Bioinformatics Laboratory, FRI UL' 
    211  
    212 # The language of the text. It defaults to the language option 
    213 # or en if the language is not set. 
    214 epub_language = 'en' 
    215  
    216 # The scheme of the identifier. Typical schemes are ISBN or URL. 
    217 #epub_scheme = '' 
    218  
    219 # The unique identifier of the text. This can be a ISBN number 
    220 # or the project homepage. 
    221 #epub_identifier = '' 
    222  
    223 # A unique identification for the text. 
    224 #epub_uid = '' 
    225  
    226 # HTML files that should be inserted before the pages created by sphinx. 
    227 # The format is a list of tuples containing the path and title. 
    228 #epub_pre_files = [] 
    229  
    230 # HTML files that should be inserted after the pages created by sphinx. 
    231 # The format is a list of tuples containing the path and title. 
    232 #epub_post_files = [] 
    233  
    234 # A list of files that should not be packed into the epub file. 
    235 epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"] 
    236  
    237 # The depth of the table of contents in toc.ncx. 
    238 #epub_tocdepth = 3 
    239  
    240 # Allow duplicate toc entries. 
    241 #epub_tocdup = True 
    242  
    243 # Example configuration for intersphinx: refer to the Python standard library. 
    244 intersphinx_mapping = { 
    245     'python': ('http://docs.python.org/', None), 
    246     'reference': ('http://orange.biolab.si/doc/reference/', 'http://orange.biolab.si/doc/reference/_objects/'), 
    247 } 
  • docs/reference/rst/Orange.classification.tree.rst

    r10959 r11028  
    13691369=================== 
    13701370 
    1371 .. include:: /SimpleTreeLearner.txt 
     1371.. include:: SimpleTreeLearner.txt 
    13721372 
    13731373--------         
  • docs/reference/rst/Orange.data.formats.rst

    r9928 r11028  
    11.. py:currentmodule:: Orange.data 
     2 
     3.. _Orange-data-formats: 
    24 
    35======================= 
  • docs/reference/rst/Orange.data.table.rst

    r10962 r11028  
    99(:obj:`Orange.data.Domain`). 
    1010 
    11 Data tables are usually loaded from a file (see :doc:`Orange.data.formats`):: 
     11Data tables are usually loaded from a file (see :ref:`Orange-data-formats`):: 
    1212 
    1313    import Orange 
     
    7676        Read data from the given file. If the name includes the 
    7777        extension it must be one of the known file formats 
    78         (see :doc:`/Orange.data.formats`). If no extension is given, the 
     78        (see :ref:`Orange-data-formats`). If no extension is given, the 
    7979        directory is searched for any file with recognized extensions. If the 
    8080        file is not found, Orange will also search the directories 
  • docs/reference/rst/conf.py

    r10881 r11028  
    1212# serve to show the default. 
    1313 
    14 import sys, os 
     14import os, sys 
    1515 
    16 #rewrite formatargs function with different defaults 
    17 sys.path.insert(0, os.path.dirname(__file__)) 
    18 import myinspect 
    19 import sphinx.ext.autodoc 
    20 import numpydoc 
    21 sphinx.ext.autodoc.inspect = myinspect 
    22 numpydoc.docscrape.inspect = myinspect 
     16sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))) 
    2317 
    24 import imp 
    25 module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', '..', '..', 'setup.py')) 
    26 VERSION = module_setup.VERSION 
     18from conf import * 
    2719 
    28 #disable deprecation decorators for the documentation 
    29 os.environ["orange_no_deprecated_members"] = "1" 
     20TITLE = "%s v%s" % ("Orange Scripting Reference", VERSION) 
    3021 
    31 # If extensions (or modules to document with autodoc) are in another directory, 
    32 # add these directories to sys.path here. If the directory is relative to the 
    33 # documentation root, use os.path.abspath to make it absolute, like shown here. 
    34 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../'))) 
    35 import Orange 
     22html_title = TITLE 
     23epub_title = TITLE 
    3624 
    37 # -- General configuration ----------------------------------------------------- 
    38  
    39 # Add any Sphinx extension module names here, as strings. They can be extensions 
    40 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    41 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig', 'numpydoc'] 
    42  
    43  
    44 # Numpydoc generates autosummary directives for all undocumented members. Orange documentation only includes documented 
    45 # member, so _str_member_list is modified to return [] where a list of undocumented members is originally returned. 
    46 numpydoc.docscrape_sphinx.SphinxDocString._str_member_list # if numpydoc changes, this line will cause an error 
    47 numpydoc.docscrape_sphinx.SphinxDocString._str_member_list = lambda x, y : [] 
    48  
    49  
    50 # Add any paths that contain templates here, relative to this directory. 
    51 templates_path = ['_templates'] 
    52  
    53 # The suffix of source filenames. 
    54 source_suffix = '.rst' 
    55  
    56 # The encoding of source files. 
    57 #source_encoding = 'utf-8' 
    58  
    59 # The master toctree document. 
    60 master_doc = 'index' 
    61  
    62 # General information about the project. 
    63 project = u'Orange' 
    64 copyright = u'Bioinformatics Laboratory, FRI UL' 
    65  
    66 # The version info for the project you're documenting, acts as replacement for 
    67 # |version| and |release|, also used in various other places throughout the 
    68 # built documents. 
    69 # 
    70 # The short X.Y version. 
    71 version = VERSION 
    72 # The full version, including alpha/beta/rc tags. 
    73 release = VERSION 
    74  
    75 # The language for content autogenerated by Sphinx. Refer to documentation 
    76 # for a list of supported languages. 
    77 #language = None 
    78  
    79 # There are two options for replacing |today|: either, you set today to some 
    80 # non-false value, then it is used: 
    81 #today = '' 
    82 # Else, today_fmt is used as the format for a strftime call. 
    83 #today_fmt = '%B %d, %Y' 
    84  
    85 # List of documents that shouldn't be included in the build. 
    86 #unused_docs = [] 
    87  
    88 # List of directories, relative to source directory, that shouldn't be searched 
    89 # for source files. 
    90 exclude_trees = ['_build'] 
    91  
    92 # The reST default role (used for this markup: `text`) to use for all documents. 
    93 #default_role = None 
    94  
    95 # If true, '()' will be appended to :func: etc. cross-reference text. 
    96 #add_function_parentheses = True 
    97  
    98 # If true, the current module name will be prepended to all description 
    99 # unit titles (such as .. function::). 
    100 #add_module_names = True 
    101  
    102 # If true, sectionauthor and moduleauthor directives will be shown in the 
    103 # output. They are ignored by default. 
    104 #show_authors = False 
    105  
    106 # The name of the Pygments (syntax highlighting) style to use. 
    107 pygments_style = 'sphinx' 
    108  
    109 # A list of ignored prefixes for module index sorting. 
    110 #modindex_common_prefix = [] 
    111  
    112  
    113 # -- Options for HTML output --------------------------------------------------- 
    114  
    115 # The theme to use for HTML and HTML Help pages.  Major themes that come with 
    116 # Sphinx are currently 'default' and 'sphinxdoc'. 
    117 html_theme = 'orange_theme' 
    118  
    119 # Theme options are theme-specific and customize the look and feel of a theme 
    120 # further.  For a list of options available for each theme, see the 
    121 # documentation. 
    122 html_theme_options = {"collapsiblesidebar": "false"} 
    123  
    124 if html_theme == "orange_theme": 
    125     html_theme_options.update({"orangeheaderfooter": "false"}) 
    126  
    127 # Add any paths that contain custom themes here, relative to this directory. 
    128 html_theme_path = ["../../sphinx-ext/themes"] 
    129  
    130 # The name for this set of Sphinx documents.  If None, it defaults to 
    131 # "<project> v<release> documentation". 
    132 html_title = "Orange Scripting Reference" 
    133  
    134 # A shorter title for the navigation bar.  Default is the same as html_title. 
    135 #html_short_title = None 
    136  
    137 # The name of an image file (relative to this directory) to place at the top 
    138 # of the sidebar. 
    139 #html_logo = None 
    140  
    141 # The name of an image file (within the static path) to use as favicon of the 
    142 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32 
    143 # pixels large. 
    144 #html_favicon = None 
    145  
    146 # Add any paths that contain custom static files (such as style sheets) here, 
    147 # relative to this directory. They are copied after the builtin static files, 
    148 # so a file named "default.css" will overwrite the builtin "default.css". 
    149 html_static_path = [] 
    150  
    151 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 
    152 # using the given strftime format. 
    153 #html_last_updated_fmt = '%b %d, %Y' 
    154  
    155 # If true, SmartyPants will be used to convert quotes and dashes to 
    156 # typographically correct entities. 
    157 #html_use_smartypants = True 
    158  
    159 # Custom sidebar templates, maps document names to template names. 
    160 #html_sidebars = {} 
    161  
    162 # Additional templates that should be rendered to pages, maps page names to 
    163 # template names. 
    164 #html_additional_pages = {} 
    165  
    166 # If false, no module index is generated. 
    167 #html_use_modindex = True 
    168  
    169 # If false, no index is generated. 
    170 #html_use_index = True 
    171  
    172 # If true, the index is split into individual pages for each letter. 
    173 #html_split_index = False 
    174  
    175 # If true, links to the reST sources are added to the pages. 
    176 #html_show_sourcelink = True 
    177  
    178 # If true, an OpenSearch description file will be output, and all pages will 
    179 # contain a <link> tag referring to it.  The value of this option must be the 
    180 # base URL from which the finished HTML is served. 
    181 #html_use_opensearch = '' 
    182  
    183 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 
    184 #html_file_suffix = '' 
    185  
    186 # Output file base name for HTML help builder. 
    187 htmlhelp_basename = 'referencedoc' 
    188  
    189  
    190 # -- Options for LaTeX output -------------------------------------------------- 
    191  
    192 # The paper size ('letter' or 'a4'). 
    193 #latex_paper_size = 'letter' 
    194  
    195 # The font size ('10pt', '11pt' or '12pt'). 
    196 #latex_font_size = '10pt' 
    197  
    198 # Grouping the document tree into LaTeX files. List of tuples 
    199 # (source start file, target name, title, author, documentclass [howto/manual]). 
    20025latex_documents = [ 
    201   ('index', 'reference.tex', u'Reference', 
    202    u't', 'manual'), 
     26  ('index', 'reference.tex', TITLE, 
     27   AUTHOR, 'manual'), 
    20328] 
    20429 
    205 # The name of an image file (relative to this directory) to place at the top of 
    206 # the title page. 
    207 #latex_logo = None 
    208  
    209 # For "manual" documents, if this is true, then toplevel headings are parts, 
    210 # not chapters. 
    211 #latex_use_parts = False 
    212  
    213 # Additional stuff for the LaTeX preamble. 
    214 #latex_preamble = '' 
    215  
    216 # Documents to append as an appendix to all manuals. 
    217 #latex_appendices = [] 
    218  
    219 # If false, no module index is generated. 
    220 #latex_use_modindex = True 
    221  
    222 # -- Options for Epub output --------------------------------------------------- 
    223  
    224 # Bibliographic Dublin Core info. 
    225 epub_title = u'Orange Scripting Reference' 
    226 epub_author = u'Biolab' 
    227 epub_publisher = u'Biolab' 
    228 epub_copyright = u'Bioinformatics Laboratory, FRI UL' 
    229  
    230 # The language of the text. It defaults to the language option 
    231 # or en if the language is not set. 
    232 epub_language = 'en' 
    233  
    234 # The scheme of the identifier. Typical schemes are ISBN or URL. 
    235 #epub_scheme = '' 
    236  
    237 # The unique identifier of the text. This can be a ISBN number 
    238 # or the project homepage. 
    239 #epub_identifier = '' 
    240  
    241 # A unique identification for the text. 
    242 #epub_uid = '' 
    243  
    244 # HTML files that should be inserted before the pages created by sphinx. 
    245 # The format is a list of tuples containing the path and title. 
    246 #epub_pre_files = [] 
    247  
    248 # HTML files that should be inserted after the pages created by sphinx. 
    249 # The format is a list of tuples containing the path and title. 
    250 #epub_post_files = [] 
    251  
    252 # A list of files that should not be packed into the epub file. 
    253 epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"] 
    254  
    255 # The depth of the table of contents in toc.ncx. 
    256 #epub_tocdepth = 3 
    257  
    258 # Allow duplicate toc entries. 
    259 #epub_tocdup = True 
    260  
    261 # Example configuration for intersphinx: refer to the Python standard library. 
    262 intersphinx_mapping = {'http://docs.python.org/': None} 
    263  
    264 import types 
    265 from sphinx.ext import autodoc 
    266  
    267 def maybe_skip_member(app, what, name, obj, skip, options): 
    268     #print app, what, name, obj, skip, options 
    269  
    270     #allow class methods that begin with __ and end with __ 
    271     if isinstance(obj, types.MethodType) \ 
    272         and not isinstance(options.members, list) \ 
    273         and name.startswith("__") \ 
    274         and name.endswith("__") \ 
    275         and (obj.__doc__ != None or options.get("undoc-members", False)): 
    276             return False 
    277  
    278 class SingletonDocumenter(autodoc.ModuleLevelDocumenter): 
    279     """ 
    280     Specialized Documenter subclass for singleton items. 
    281     """ 
    282     objtype = 'singleton' 
    283     directivetype = 'data' 
    284  
    285     member_order = 40 
    286  
    287     @classmethod 
    288     def can_document_member(cls, member, membername, isattr, parent): 
    289         return isinstance(parent, autodoc.ModuleDocumenter) and isattr 
    290  
    291     def document_members(self, all_members=False): 
    292         pass 
    293  
    294     def add_content(self, more_content, no_docstring=False): 
    295         self.add_line(u'Singleton instance of :py:class:`~%s`.' % (self.object.__class__.__name__,), '<autodoc>') 
    296  
    297 def setup(app): 
    298     app.connect('autodoc-skip-member', maybe_skip_member) 
    299     app.add_autodocumenter(SingletonDocumenter) 
  • docs/tutorial/rst/association-rules.rst

    r9994 r11028  
    117117   0.898   0.429   1.116   fuel-type=gas num-of-doors=four -> aspiration=std engine-location=front 
    118118    
    119 Finally, for our third example, we introduce cloning. Cloning helps if 
    120 you require to work with different rule subsets that stem from common 
    121 rule set created from some data (actually, cloning is quite useless in 
    122 our example, but may be very useful otherwise). So, we use cloning to 
    123 make a copy of the set of rules, then sort by first support and then 
    124 confidence, and then print out few best rules. We have also lower 
    125 required minimal support, just to see how many rules we obtain in this 
    126 way (:download:`assoc3.py <code/assoc3.py>`, :download:`imports-85.tab <code/imports-85.tab>`):: 
    127  
    128    minSupport = 0.2 
    129    rules = orngAssoc.build(data, minSupport) 
    130    print "%i rules with support higher than or equal to %5.3f found.\n" % (len(rules), minSupport) 
    131     
    132    rules2 = rules.clone() 
    133    rules2.sortByConfidence() 
    134     
    135    n = 5 
    136    print "Best %i rules:" % n 
    137    subset = rules[:n] 
    138    subset.printMeasures(['support','confidence']) 
    139  
    140 The output of this script is:: 
    141  
    142    828 rules with support higher than or equal to 0.200 found. 
    143     
    144    Best 5 rules: 
    145    supp    conf    rule 
    146    0.888   0.984   engine-location=front -> fuel-type=gas 
    147    0.888   0.901   fuel-type=gas -> engine-location=front 
    148    0.805   0.982   engine-location=front -> aspiration=std 
    149    0.805   0.817   aspiration=std -> engine-location=front 
    150    0.785   0.958   fuel-type=gas -> aspiration=std 
    151  
    152  
  • docs/tutorial/rst/conf.py

    r10881 r11028  
    1212# serve to show the default. 
    1313 
    14 import sys, os 
     14import os, sys 
    1515 
    16 import imp 
    17 module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', '..', '..', 'setup.py')) 
    18 VERSION = module_setup.VERSION 
     16sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))) 
    1917 
    20 # If extensions (or modules to document with autodoc) are in another directory, 
    21 # add these directories to sys.path here. If the directory is relative to the 
    22 # documentation root, use os.path.abspath to make it absolute, like shown here. 
    23 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../'))) 
    24 import Orange 
     18from conf import * 
    2519 
    26 # -- General configuration ----------------------------------------------------- 
     20TITLE = "%s v%s" % ("Orange Tutorial", VERSION) 
    2721 
    28 # Add any Sphinx extension module names here, as strings. They can be extensions 
    29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    30 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.pngmath'] 
     22html_title = TITLE 
     23epub_title = TITLE 
    3124 
    32 # Add any paths that contain templates here, relative to this directory. 
    33 templates_path = ['_templates'] 
     25latex_documents = [ 
     26    ('index', 'reference.tex', TITLE, 
     27     AUTHOR, 'manual'), 
     28    ] 
    3429 
    35 # The suffix of source filenames. 
    36 source_suffix = '.rst' 
    37  
    38 # The encoding of source files. 
    39 #source_encoding = 'utf-8' 
    40  
    41 # The master toctree document. 
    42 master_doc = 'index' 
    43  
    44 # General information about the project. 
    45 project = u'Orange' 
    46 copyright = u'Bioinformatics Laboratory, FRI UL' 
    47  
    48 # The version info for the project you're documenting, acts as replacement for 
    49 # |version| and |release|, also used in various other places throughout the 
    50 # built documents. 
    51 # 
    52 # The short X.Y version. 
    53 version = VERSION 
    54 # The full version, including alpha/beta/rc tags. 
    55 release = VERSION 
    56  
    57 # The language for content autogenerated by Sphinx. Refer to documentation 
    58 # for a list of supported languages. 
    59 #language = None 
    60  
    61 # There are two options for replacing |today|: either, you set today to some 
    62 # non-false value, then it is used: 
    63 #today = '' 
    64 # Else, today_fmt is used as the format for a strftime call. 
    65 #today_fmt = '%B %d, %Y' 
    66  
    67 # List of documents that shouldn't be included in the build. 
    68 #unused_docs = [] 
    69  
    70 # List of directories, relative to source directory, that shouldn't be searched 
    71 # for source files. 
    72 exclude_trees = ['_build'] 
    73  
    74 # The reST default role (used for this markup: `text`) to use for all documents. 
    75 #default_role = None 
    76  
    77 # If true, '()' will be appended to :func: etc. cross-reference text. 
    78 #add_function_parentheses = True 
    79  
    80 # If true, the current module name will be prepended to all description 
    81 # unit titles (such as .. function::). 
    82 #add_module_names = True 
    83  
    84 # If true, sectionauthor and moduleauthor directives will be shown in the 
    85 # output. They are ignored by default. 
    86 #show_authors = False 
    87  
    88 # The name of the Pygments (syntax highlighting) style to use. 
    89 pygments_style = 'sphinx' 
    90  
    91 # A list of ignored prefixes for module index sorting. 
    92 #modindex_common_prefix = [] 
    93  
    94  
    95 # -- Options for HTML output --------------------------------------------------- 
    96  
    97 # The theme to use for HTML and HTML Help pages.  Major themes that come with 
    98 # Sphinx are currently 'default' and 'sphinxdoc'. 
    99 html_theme = 'orange_theme' 
    100  
    101 # Theme options are theme-specific and customize the look and feel of a theme 
    102 # further.  For a list of options available for each theme, see the 
    103 # documentation. 
    104 html_theme_options = {"collapsiblesidebar": "false"} 
    105  
    106 if html_theme == "orange_theme": 
    107     html_theme_options.update({"orangeheaderfooter": "false"}) 
    108  
    109 # Add any paths that contain custom themes here, relative to this directory. 
    110 html_theme_path = ["../../sphinx-ext/themes"] 
    111  
    112 # The name for this set of Sphinx documents.  If None, it defaults to 
    113 # "<project> v<release> documentation". 
    114 html_title = "Orange Tutorial" 
    115  
    116 # A shorter title for the navigation bar.  Default is the same as html_title. 
    117 #html_short_title = None 
    118  
    119 # The name of an image file (relative to this directory) to place at the top 
    120 # of the sidebar. 
    121 #html_logo = None 
    122  
    123 # The name of an image file (within the static path) to use as favicon of the 
    124 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32 
    125 # pixels large. 
    126 #html_favicon = None 
    127  
    128 # Add any paths that contain custom static files (such as style sheets) here, 
    129 # relative to this directory. They are copied after the builtin static files, 
    130 # so a file named "default.css" will overwrite the builtin "default.css". 
    131 html_static_path = [] 
    132  
    133 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 
    134 # using the given strftime format. 
    135 #html_last_updated_fmt = '%b %d, %Y' 
    136  
    137 # If true, SmartyPants will be used to convert quotes and dashes to 
    138 # typographically correct entities. 
    139 #html_use_smartypants = True 
    140  
    141 # Custom sidebar templates, maps document names to template names. 
    142 #html_sidebars = {} 
    143  
    144 # Additional templates that should be rendered to pages, maps page names to 
    145 # template names. 
    146 #html_additional_pages = {} 
    147  
    148 # If false, no module index is generated. 
    149 #html_use_modindex = True 
    150  
    151 # If false, no index is generated. 
    152 #html_use_index = True 
    153  
    154 # If true, the index is split into individual pages for each letter. 
    155 #html_split_index = False 
    156  
    157 # If true, links to the reST sources are added to the pages. 
    158 #html_show_sourcelink = True 
    159  
    160 # If true, an OpenSearch description file will be output, and all pages will 
    161 # contain a <link> tag referring to it.  The value of this option must be the 
    162 # base URL from which the finished HTML is served. 
    163 #html_use_opensearch = '' 
    164  
    165 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 
    166 #html_file_suffix = '' 
    167  
    168 # Output file base name for HTML help builder. 
    169 htmlhelp_basename = 'tutorialdoc' 
    170  
    171  
    172 # -- Options for LaTeX output -------------------------------------------------- 
    173  
    174 # The paper size ('letter' or 'a4'). 
    175 #latex_paper_size = 'letter' 
    176  
    177 # The font size ('10pt', '11pt' or '12pt'). 
    178 #latex_font_size = '10pt' 
    179  
    180 # Grouping the document tree into LaTeX files. List of tuples 
    181 # (source start file, target name, title, author, documentclass [howto/manual]). 
    182 latex_documents = [ 
    183   ('index', 'tutorial.tex', u'Tutorial', 
    184    u'Biolab', 'manual'), 
    185 ] 
    186  
    187 # The name of an image file (relative to this directory) to place at the top of 
    188 # the title page. 
    189 #latex_logo = None 
    190  
    191 # For "manual" documents, if this is true, then toplevel headings are parts, 
    192 # not chapters. 
    193 #latex_use_parts = False 
    194  
    195 # Additional stuff for the LaTeX preamble. 
    196 #latex_preamble = '' 
    197  
    198 # Documents to append as an appendix to all manuals. 
    199 #latex_appendices = [] 
    200  
    201 # If false, no module index is generated. 
    202 #latex_use_modindex = True 
    203  
    204 # -- Options for Epub output --------------------------------------------------- 
    205  
    206 # Bibliographic Dublin Core info. 
    207 epub_title = u'Orange Tutorial' 
    208 epub_author = u'Biolab' 
    209 epub_publisher = u'Biolab' 
    210 epub_copyright = u'Bioinformatics Laboratory, FRI UL' 
    211  
    212 # The language of the text. It defaults to the language option 
    213 # or en if the language is not set. 
    214 epub_language = 'en' 
    215  
    216 # The scheme of the identifier. Typical schemes are ISBN or URL. 
    217 #epub_scheme = '' 
    218  
    219 # The unique identifier of the text. This can be a ISBN number 
    220 # or the project homepage. 
    221 #epub_identifier = '' 
    222  
    223 # A unique identification for the text. 
    224 #epub_uid = '' 
    225  
    226 # HTML files that should be inserted before the pages created by sphinx. 
    227 # The format is a list of tuples containing the path and title. 
    228 #epub_pre_files = [] 
    229  
    230 # HTML files that should be inserted after the pages created by sphinx. 
    231 # The format is a list of tuples containing the path and title. 
    232 #epub_post_files = [] 
    233  
    234 # A list of files that should not be packed into the epub file. 
    235 epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"] 
    236  
    237 # The depth of the table of contents in toc.ncx. 
    238 #epub_tocdepth = 3 
    239  
    240 # Allow duplicate toc entries. 
    241 #epub_tocdup = True 
    242  
    243 # Example configuration for intersphinx: refer to the Python standard library. 
    244 intersphinx_mapping = { 
    245     'python': ('http://docs.python.org/', None), 
    246     'reference': ('http://orange.biolab.si/doc/reference/', 'http://orange.biolab.si/doc/reference/_objects/'), 
    247 } 
  • docs/tutorial/rst/start.rst

    r9859 r11028  
    55<http://orange.biolab.si/download/>`_ and install Orange. Python scripts can 
    66be run in a terminal window, integrated environments 
    7 like `PyCharm<http://www.jetbrains.com/pycharm/>`_ and `PythonWin<http://wiki.python.org/moin/PythonWin>`_, 
    8 or shells like `iPython<http://ipython.scipy.org/moin/>`_. This tutorial will run the 
     7like `PyCharm <http://www.jetbrains.com/pycharm/>`_ and `PythonWin <http://wiki.python.org/moin/PythonWin>`_, 
     8or shells like `iPython <http://ipython.scipy.org/moin/>`_. This tutorial will run the 
    99Python code in the 
    1010terminal 
  • docs/widgets/rst/conf.py

    r10881 r11028  
    1212# serve to show the default. 
    1313 
    14 import sys, os 
     14import os, sys 
    1515 
    16 import imp 
    17 module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', '..', '..', 'setup.py')) 
    18 VERSION = module_setup.VERSION 
     16sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))) 
    1917 
    20 # If extensions (or modules to document with autodoc) are in another directory, 
    21 # add these directories to sys.path here. If the directory is relative to the 
    22 # documentation root, use os.path.abspath to make it absolute, like shown here. 
    23 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../'))) 
    24 import Orange 
     18from conf import * 
    2519 
    26 # -- General configuration ----------------------------------------------------- 
     20TITLE = "%s v%s" % ("Orange Widgets", VERSION) 
    2721 
    28 # Add any Sphinx extension module names here, as strings. They can be extensions 
    29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    30 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 
    31               'sphinx.ext.pngmath'] 
     22html_title = TITLE 
     23epub_title = TITLE 
    3224 
    33 # Add any paths that contain templates here, relative to this directory. 
    34 templates_path = ['_templates'] 
     25latex_documents = [ 
     26    ('index', 'reference.tex', TITLE, 
     27     AUTHOR, 'manual'), 
     28    ] 
    3529 
    36 # The suffix of source filenames. 
    37 source_suffix = '.rst' 
    3830 
    39 # The encoding of source files. 
    40 #source_encoding = 'utf-8' 
    41  
    42 # The master toctree document. 
    43 master_doc = 'index' 
    4431 
    4532# rst epilog with shortcuts for screen shoot numbers 
     
    8572       :alt: 10 
    8673""" 
    87  
    88 # General information about the project. 
    89 project = u'Orange' 
    90 copyright = u'Bioinformatics Laboratory, FRI UL' 
    91  
    92 # The version info for the project you're documenting, acts as replacement for 
    93 # |version| and |release|, also used in various other places throughout the 
    94 # built documents. 
    95 # 
    96 # The short X.Y version. 
    97 version = VERSION 
    98 # The full version, including alpha/beta/rc tags. 
    99 release = VERSION 
    100  
    101 # The language for content autogenerated by Sphinx. Refer to documentation 
    102 # for a list of supported languages. 
    103 #language = None 
    104  
    105 # There are two options for replacing |today|: either, you set today to some 
    106 # non-false value, then it is used: 
    107 #today = '' 
    108 # Else, today_fmt is used as the format for a strftime call. 
    109 #today_fmt = '%B %d, %Y' 
    110  
    111 # List of documents that shouldn't be included in the build. 
    112 #unused_docs = [] 
    113  
    114 # List of directories, relative to source directory, that shouldn't be searched 
    115 # for source files. 
    116 exclude_trees = ['_build'] 
    117  
    118 # The reST default role (used for this markup: `text`) to use for all documents. 
    119 #default_role = None 
    120  
    121 # If true, '()' will be appended to :func: etc. cross-reference text. 
    122 #add_function_parentheses = True 
    123  
    124 # If true, the current module name will be prepended to all description 
    125 # unit titles (such as .. function::). 
    126 #add_module_names = True 
    127  
    128 # If true, sectionauthor and moduleauthor directives will be shown in the 
    129 # output. They are ignored by default. 
    130 #show_authors = False 
    131  
    132 # The name of the Pygments (syntax highlighting) style to use. 
    133 pygments_style = 'sphinx' 
    134  
    135 # A list of ignored prefixes for module index sorting. 
    136 #modindex_common_prefix = [] 
    137  
    138  
    139 # -- Options for HTML output --------------------------------------------------- 
    140  
    141 # The theme to use for HTML and HTML Help pages.  Major themes that come with 
    142 # Sphinx are currently 'default' and 'sphinxdoc'. 
    143 html_theme = 'orange_theme' 
    144  
    145 # Theme options are theme-specific and customize the look and feel of a theme 
    146 # further.  For a list of options available for each theme, see the 
    147 # documentation. 
    148 html_theme_options = {"collapsiblesidebar": "false"} 
    149  
    150 if html_theme == "orange_theme": 
    151     html_theme_options.update({"orangeheaderfooter": "false"}) 
    152  
    153 # Add any paths that contain custom themes here, relative to this directory. 
    154 html_theme_path = ["../../sphinx-ext/themes"] 
    155  
    156 # The name for this set of Sphinx documents.  If None, it defaults to 
    157 # "<project> v<release> documentation". 
    158 html_title = "Orange Widgets" 
    159  
    160 # A shorter title for the navigation bar.  Default is the same as html_title. 
    161 #html_short_title = None 
    162  
    163 # The name of an image file (relative to this directory) to place at the top 
    164 # of the sidebar. 
    165 #html_logo = None 
    166  
    167 # The name of an image file (within the static path) to use as favicon of the 
    168 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32 
    169 # pixels large. 
    170 #html_favicon = None 
    171  
    172 # Add any paths that contain custom static files (such as style sheets) here, 
    173 # relative to this directory. They are copied after the builtin static files, 
    174 # so a file named "default.css" will overwrite the builtin "default.css". 
    175  
    176 # The old widgets documentation is copied here 
    177 html_static_path = ["../../../Orange/doc/widgets"] 
    178  
    179 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 
    180 # using the given strftime format. 
    181 #html_last_updated_fmt = '%b %d, %Y' 
    182  
    183 # If true, SmartyPants will be used to convert quotes and dashes to 
    184 # typographically correct entities. 
    185 #html_use_smartypants = True 
    186  
    187 # Custom sidebar templates, maps document names to template names. 
    188 #html_sidebars = {} 
    189  
    190 # Additional templates that should be rendered to pages, maps page names to 
    191 # template names. 
    192 #html_additional_pages = {} 
    193  
    194 # If false, no module index is generated. 
    195 #html_use_modindex = True 
    196  
    197 # If false, no index is generated. 
    198 #html_use_index = True 
    199  
    200 # If true, the index is split into individual pages for each letter. 
    201 #html_split_index = False 
    202  
    203 # If true, links to the reST sources are added to the pages. 
    204 #html_show_sourcelink = True 
    205  
    206 # If true, an OpenSearch description file will be output, and all pages will 
    207 # contain a <link> tag referring to it.  The value of this option must be the 
    208 # base URL from which the finished HTML is served. 
    209 #html_use_opensearch = '' 
    210  
    211 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 
    212 #html_file_suffix = '' 
    213  
    214 # Output file base name for HTML help builder. 
    215 htmlhelp_basename = 'widgetsdoc' 
    216  
    217  
    218 # -- Options for LaTeX output -------------------------------------------------- 
    219  
    220 # The paper size ('letter' or 'a4'). 
    221 #latex_paper_size = 'letter' 
    222  
    223 # The font size ('10pt', '11pt' or '12pt'). 
    224 #latex_font_size = '10pt' 
    225  
    226 # Grouping the document tree into LaTeX files. List of tuples 
    227 # (source start file, target name, title, author, documentclass [howto/manual]). 
    228 latex_documents = [ 
    229   ('index', 'widgets.tex', u'Widgets', 
    230    u'Biolab', 'manual'), 
    231 ] 
    232  
    233 # The name of an image file (relative to this directory) to place at the top of 
    234 # the title page. 
    235 #latex_logo = None 
    236  
    237 # For "manual" documents, if this is true, then toplevel headings are parts, 
    238 # not chapters. 
    239 #latex_use_parts = False 
    240  
    241 # Additional stuff for the LaTeX preamble. 
    242 #latex_preamble = '' 
    243  
    244 # Documents to append as an appendix to all manuals. 
    245 #latex_appendices = [] 
    246  
    247 # If false, no module index is generated. 
    248 #latex_use_modindex = True 
    249  
    250 # -- Options for Epub output --------------------------------------------------- 
    251  
    252 # Bibliographic Dublin Core info. 
    253 epub_title = u'Orange Widgets' 
    254 epub_author = u'Biolab' 
    255 epub_publisher = u'Biolab' 
    256 epub_copyright = u'Bioinformatics Laboratory, FRI UL' 
    257  
    258 # The language of the text. It defaults to the language option 
    259 # or en if the language is not set. 
    260 epub_language = 'en' 
    261  
    262 # The scheme of the identifier. Typical schemes are ISBN or URL. 
    263 #epub_scheme = '' 
    264  
    265 # The unique identifier of the text. This can be a ISBN number 
    266 # or the project homepage. 
    267 #epub_identifier = '' 
    268  
    269 # A unique identification for the text. 
    270 #epub_uid = '' 
    271  
    272 # HTML files that should be inserted before the pages created by sphinx. 
    273 # The format is a list of tuples containing the path and title. 
    274 #epub_pre_files = [] 
    275  
    276 # HTML files that should be inserted after the pages created by sphinx. 
    277 # The format is a list of tuples containing the path and title. 
    278 #epub_post_files = [] 
    279  
    280 # A list of files that should not be packed into the epub file. 
    281 epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"] 
    282  
    283 # The depth of the table of contents in toc.ncx. 
    284 #epub_tocdepth = 3 
    285  
    286 # Allow duplicate toc entries. 
    287 #epub_tocdup = True 
    288  
    289 # Example configuration for intersphinx: refer to the Python standard library. 
    290 intersphinx_mapping = { 
    291     'python': ('http://docs.python.org/', None), 
    292     'reference': ('http://orange.biolab.si/doc/reference/', 'http://orange.biolab.si/doc/reference/_objects/'), 
    293 } 
    294  
    295 from docutils import nodes 
    296 from docutils.transforms import Transform 
    297   
    298 class StampListDecorate(Transform): 
    299     """Decorate a list with pixmap bullet points. 
    300      
    301     Example:: 
    302      
    303         .. rst-class: stamp-list 
    304          
    305             1. First 
    306             2. Second 
    307          
    308          
    309     """ 
    310     default_priority = 1000 
    311     def apply(self): 
    312         for node in self.document.traverse(nodes.Node): 
    313             if isinstance(node,  nodes.Node) and not isinstance(node, nodes.Text): 
    314                 if "stamp-list" in node["classes"][:]: 
    315                     self.decorate(node) 
    316                  
    317     def decorate(self, node): 
    318         for ol in node.traverse(nodes.enumerated_list): 
    319             start = int(ol["start"]) if "start" in ol else 1 
    320             for i, list_item in enumerate(ol.traverse(nodes.list_item)): 
    321                 list_item["classes"].append("list-item-%i" % (start + i)) 
    322  
    323 def setup(app): 
    324     app.add_transform(StampListDecorate) 
  • docs/widgets/rst/data/file.rst

    r9388 r11028  
    5858-------- 
    5959 
    60 Any of your schemas should probably start with the File_ widget. In the schema below,  
     60Any of your schemas should probably start with the :ref:`File` widget. In the schema below, 
    6161the widget is used to read the data that is then sent to both :ref:`Data Table` widget and  
    62 to widget that displays :ref:`Attribute Statistics`. 
     62to widget that displays `Attribute Statistics`_. 
    6363 
    6464.. image:: images/File_schema.png 
Note: See TracChangeset for help on using the changeset viewer.