Changeset 1662:427f1876f3e6 in orange-bioinformatics for docs/widgets/rst/conf.py


Ignore:
Timestamp:
05/21/12 15:39:56 (2 years ago)
Author:
mitar
Branch:
default
Message:

Revamped documentation.

File:
1 edited

Legend:

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

    r1623 r1662  
    11# -*- coding: utf-8 -*- 
    2 # 
    3 # Orange widget catalog documentation build configuration file, created by 
    4 # sphinx-quickstart on Fri Oct  8 15:09:05 2010. 
    52# 
    63# This file is execfile()d with the current directory set to its containing dir. 
     
    1310 
    1411import sys, os 
     12 
     13import imp 
     14module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', '..', '..', 'setup.py')) 
     15VERSION = module_setup.VERSION 
     16AUTHOR = module_setup.AUTHOR 
     17NAME = module_setup.NAME 
     18 
     19DOCUMENTATION_TYPE = "Widgets" 
     20 
     21TITLE = "%s %s v%s documentation" % (NAME, DOCUMENTATION_TYPE, VERSION) 
    1522 
    1623# If extensions (or modules to document with autodoc) are in another directory, 
     
    2330# Add any Sphinx extension module names here, as strings. They can be extensions 
    2431# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    25 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath'] 
     32extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.pngmath'] 
    2633 
    2734# Add any paths that contain templates here, relative to this directory. 
     
    3845 
    3946# General information about the project. 
    40 project = u'Orange widget catalog' 
    41 copyright = u'Bioinformatics Laboratory, FRI UL' 
     47project = NAME 
     48copyright = AUTHOR 
    4249 
    4350# The version info for the project you're documenting, acts as replacement for 
     
    4653# 
    4754# The short X.Y version. 
    48 version = '2.0b' 
     55version = VERSION 
    4956# The full version, including alpha/beta/rc tags. 
    50 release = '2.0b' 
     57release = VERSION 
    5158 
    5259# The language for content autogenerated by Sphinx. Refer to documentation 
     
    9299# The theme to use for HTML and HTML Help pages.  Major themes that come with 
    93100# Sphinx are currently 'default' and 'sphinxdoc'. 
    94 html_theme = 'orange_theme' 
     101html_theme = 'nature' 
    95102 
    96103# Theme options are theme-specific and customize the look and feel of a theme 
    97104# further.  For a list of options available for each theme, see the 
    98105# documentation. 
    99 html_theme_options = {"collapsiblesidebar": "true"} 
    100 if html_theme == "orange_theme": 
    101     html_theme_options.update({"orangeheaderfooter": "false"}) 
    102      
     106#html_theme_options = {} 
    103107 
    104108# Add any paths that contain custom themes here, relative to this directory. 
    105 html_theme_path = ["../../sphinx-ext/themes"] 
     109#html_theme_path = [] 
    106110 
    107111# The name for this set of Sphinx documents.  If None, it defaults to 
    108112# "<project> v<release> documentation". 
    109 html_title = project 
     113html_title = TITLE 
    110114 
    111115# A shorter title for the navigation bar.  Default is the same as html_title. 
     
    135139 
    136140# Custom sidebar templates, maps document names to template names. 
    137 html_sidebars = { 
    138    '*': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'], 
    139    '*/*': [], #Disable sidebar for individual widgets  
    140 } 
    141  
     141#html_sidebars = {} 
    142142 
    143143# Additional templates that should be rendered to pages, maps page names to 
     
    146146 
    147147# If false, no module index is generated. 
    148 #html_use_modindex = True 
     148#html_domain_indices = True 
    149149 
    150150# If false, no index is generated. 
     
    156156# If true, links to the reST sources are added to the pages. 
    157157#html_show_sourcelink = True 
     158 
     159# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 
     160html_show_sphinx = False 
     161 
     162# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 
     163html_show_copyright = False 
    158164 
    159165# If true, an OpenSearch description file will be output, and all pages will 
     
    166172 
    167173# Output file base name for HTML help builder. 
    168 htmlhelp_basename = 'Orangewidgetcatalogdoc' 
     174htmlhelp_basename = DOCUMENTATION_TYPE.lower().replace(' ', '') 
    169175 
    170176 
     
    180186# (source start file, target name, title, author, documentclass [howto/manual]). 
    181187latex_documents = [ 
    182   ('index', 'Orangewidgetcatalog.tex', u'Orange widget catalog Documentation', 
    183    u'Blaz Zupan', 'manual'), 
     188  ('index', '%s.tex' % (DOCUMENTATION_TYPE.lower().replace(' ', ''),), html_title, 
     189   copyright, 'manual'), 
    184190] 
    185191 
     
    192198#latex_use_parts = False 
    193199 
     200# If true, show page references after internal links. 
     201#latex_show_pagerefs = False 
     202 
     203# If true, show URL addresses after external links. 
     204#latex_show_urls = False 
     205 
    194206# Additional stuff for the LaTeX preamble. 
    195207#latex_preamble = '' 
     
    199211 
    200212# If false, no module index is generated. 
    201 #latex_use_modindex = True 
     213#latex_domain_indices = True 
     214 
     215# -- Options for manual page output -------------------------------------------- 
     216 
     217# One entry per manual page. List of tuples 
     218# (source start file, name, description, authors, manual section). 
     219man_pages = [ 
     220    ('index', DOCUMENTATION_TYPE.lower().replace(' ', ''), TITLE, 
     221     [AUTHOR], 1) 
     222] 
     223 
     224# Example configuration for intersphinx: refer to the Python standard library. 
     225intersphinx_mapping = { 
     226    'python': ('http://python.readthedocs.org/en/latest/', None), 
     227} 
     228 
Note: See TracChangeset for help on using the changeset viewer.