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

Added a common documentation index.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • 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 } 
Note: See TracChangeset for help on using the changeset viewer.