Changeset 9387:4cfea82363ea in orange


Ignore:
Timestamp:
12/18/11 04:44:24 (2 years ago)
Author:
mitar
Branch:
default
Convert:
090942c0965731ebecde0c72e5a36adf76fca013
Message:

Structuring widgets documentation.

Location:
docs
Files:
12 added
19 deleted
5 edited

Legend:

Unmodified
Added
Removed
  • docs/reference/rst/conf.py

    r9376 r9387  
    11# -*- coding: utf-8 -*- 
    22# 
    3 # test documentation build configuration file, created by 
     3# reference documentation build configuration file, created by 
    44# sphinx-quickstart on Wed Nov 17 12:52:23 2010. 
    55# 
  • docs/tutorial/rst/conf.py

    r9385 r9387  
    11# -*- coding: utf-8 -*- 
    22# 
    3 # ofb documentation build configuration file, created by 
     3# tutorial documentation build configuration file, created by 
    44# sphinx-quickstart on Fri Jul 16 13:29:06 2010. 
    55# 
  • docs/widgets/Makefile

    r9376 r9387  
    3030 
    3131clean: 
    32     -rm -rf _* *.html html .doctrees .buildinfo searchindex.js *.epub epub 
     32    -rm -rf _* *.html html .doctrees .buildinfo searchindex.js *.epub epub rst/_build 
    3333 
    3434epub: 
  • docs/widgets/rst/conf.py

    r9372 r9387  
    11# -*- coding: utf-8 -*- 
    22# 
    3 # Orange widget catalog documentation build configuration file, created by 
     3# widgets documentation build configuration file, created by 
    44# sphinx-quickstart on Fri Oct  8 15:09:05 2010. 
    55# 
     
    2323# Add any Sphinx extension module names here, as strings. They can be extensions 
    2424# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    25 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath'] 
     25extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.pngmath'] 
    2626 
    2727# Add any paths that contain templates here, relative to this directory. 
     
    3737master_doc = 'index' 
    3838 
    39 # rst epliog 
     39# rst epilog with shortcuts for screen shoot numbers 
    4040rst_epilog = """ 
    4141.. |1| image:: /images/1.png 
     
    7070""" 
    7171 
    72  
    7372# General information about the project. 
    74 project = u'Orange widget catalog' 
     73project = u'Orange' 
    7574copyright = u'Bioinformatics Laboratory, FRI UL' 
    7675 
     
    8079# 
    8180# The short X.Y version. 
    82 version = '2.0b' 
     81version = '2.5' 
    8382# The full version, including alpha/beta/rc tags. 
    84 release = '2.0b' 
     83release = '2.5 beta' 
    8584 
    8685# The language for content autogenerated by Sphinx. Refer to documentation 
     
    131130# further.  For a list of options available for each theme, see the 
    132131# documentation. 
    133 html_theme_options = {"collapsiblesidebar": "true"} 
     132html_theme_options = {"collapsiblesidebar": "false"} 
     133 
    134134if html_theme == "orange_theme": 
    135135    html_theme_options.update({"orangeheaderfooter": "false"}) 
    136      
    137136 
    138137# Add any paths that contain custom themes here, relative to this directory. 
     
    141140# The name for this set of Sphinx documents.  If None, it defaults to 
    142141# "<project> v<release> documentation". 
    143 html_title = project 
     142html_title = "Orange Widgets" 
    144143 
    145144# A shorter title for the navigation bar.  Default is the same as html_title. 
     
    158157# relative to this directory. They are copied after the builtin static files, 
    159158# so a file named "default.css" will overwrite the builtin "default.css". 
    160 html_static_path = ['_static'] 
     159html_static_path = [] 
    161160 
    162161# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 
     
    169168 
    170169# Custom sidebar templates, maps document names to template names. 
    171 html_sidebars = { 
    172    '*': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'], 
    173    '*/*': [], #Disable sidebar for individual widgets  
    174 } 
    175  
     170#html_sidebars = {} 
    176171 
    177172# Additional templates that should be rendered to pages, maps page names to 
     
    200195 
    201196# Output file base name for HTML help builder. 
    202 htmlhelp_basename = 'Orangewidgetcatalogdoc' 
     197htmlhelp_basename = 'widgetsdoc' 
    203198 
    204199 
     
    214209# (source start file, target name, title, author, documentclass [howto/manual]). 
    215210latex_documents = [ 
    216   ('index', 'Orangewidgetcatalog.tex', u'Orange widget catalog Documentation', 
    217    u'Blaz Zupan', 'manual'), 
     211  ('index', 'widgets.tex', u'Widgets', 
     212   u'Biolab', 'manual'), 
    218213] 
    219214 
     
    234229# If false, no module index is generated. 
    235230#latex_use_modindex = True 
     231 
     232# -- Options for Epub output --------------------------------------------------- 
     233 
     234# Bibliographic Dublin Core info. 
     235epub_title = u'Orange Widgets' 
     236epub_author = u'Biolab' 
     237epub_publisher = u'Biolab' 
     238epub_copyright = u'Bioinformatics Laboratory, FRI UL' 
     239 
     240# The language of the text. It defaults to the language option 
     241# or en if the language is not set. 
     242epub_language = 'en' 
     243 
     244# The scheme of the identifier. Typical schemes are ISBN or URL. 
     245#epub_scheme = '' 
     246 
     247# The unique identifier of the text. This can be a ISBN number 
     248# or the project homepage. 
     249#epub_identifier = '' 
     250 
     251# A unique identification for the text. 
     252#epub_uid = '' 
     253 
     254# HTML files that should be inserted before the pages created by sphinx. 
     255# The format is a list of tuples containing the path and title. 
     256#epub_pre_files = [] 
     257 
     258# HTML files that should be inserted after the pages created by sphinx. 
     259# The format is a list of tuples containing the path and title. 
     260#epub_post_files = [] 
     261 
     262# A list of files that should not be packed into the epub file. 
     263epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"] 
     264 
     265# The depth of the table of contents in toc.ncx. 
     266#epub_tocdepth = 3 
     267 
     268# Allow duplicate toc entries. 
     269#epub_tocdup = True 
     270 
     271# Example configuration for intersphinx: refer to the Python standard library. 
     272intersphinx_mapping = { 
     273    'python': ('http://docs.python.org/', None), 
     274    'reference': ('http://orange.biolab.si/doc/reference/', 'http://orange.biolab.si/doc/reference/_objects/'), 
     275} 
     276 
    236277from docutils import nodes 
    237278from docutils.transforms import Transform 
     
    250291            for i, list_item in enumerate(ol.traverse(nodes.list_item)): 
    251292                list_item["classes"].append("list-item-%i" % (start + i)) 
    252                  
    253      
     293 
    254294def setup(app): 
    255295    app.add_transform(StampListDecorate) 
    256  
  • docs/widgets/rst/index.rst

    r9372 r9387  
    1 .. Orange Widget Catalog documentation master file, created by 
    2    sphinx-quickstart on Mon Oct 11 17:05:09 2010. 
    3    You can adapt this file completely to your liking, but it should at least 
    4    contain the root `toctree` directive. 
    5  
    6 Welcome to Orange Widget Catalog's documentation! 
    7 ================================================= 
     1############## 
     2Orange Widgets 
     3############## 
    84 
    95Contents: 
     
    128   :maxdepth: 1 
    139    
    14    Data/File.rst 
    15    Data/DataTable.rst 
    16    Data/SelectAttributes.rst 
     10   data/file.rst 
     11   data/data-table.rst 
     12   data/select-attributes.rst 
    1713 
    18 Indices and tables 
    19 ================== 
     14**************** 
     15Index and search 
     16**************** 
    2017 
    2118* :ref:`genindex` 
    22 * :ref:`modindex` 
    2319* :ref:`search` 
    24  
Note: See TracChangeset for help on using the changeset viewer.