annotate docs/conf.py @ 11:7571f5c89090

Simple error message now output to HTML. Detailed error goes to standard error. Other changes: * Remove information on time taken (riboplot). * Remove striped table styles (not used. unusable on sorting). * log before re-raising errors.

1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3 #
4 # riboplot documentation build configuration file, created by
5 # sphinx-quickstart on Tue Jul  9 22:26:36 2013.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15 
16 import sys
17 import os
18 
19 # If extensions (or modules to document with autodoc) are in another
20 # directory, add these directories to sys.path here. If the directory is
21 # relative to the documentation root, use os.path.abspath to make it
22 # absolute, like shown here.
23 #sys.path.insert(0, os.path.abspath('.'))
24 
25 # Get the project root dir, which is the parent dir of this
26 cwd = os.getcwd()
27 project_root = os.path.dirname(cwd)
28 
29 # Insert the project root dir as the first element in the PYTHONPATH.
30 # This lets us ensure that the source package is imported, and that its
31 # version is used.
32 sys.path.insert(0, project_root)
33 
34 import riboplot
35 
36 # -- General configuration ---------------------------------------------
37 
38 # If your documentation needs a minimal Sphinx version, state it here.
39 #needs_sphinx = '1.0'
40 
41 # Add any Sphinx extension module names here, as strings. They can be
42 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
43 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
44 
45 # Add any paths that contain templates here, relative to this directory.
46 templates_path = ['_templates']
47 
48 # The suffix of source filenames.
49 source_suffix = '.rst'
50 
51 # The encoding of source files.
52 #source_encoding = 'utf-8-sig'
53 
54 # The master toctree document.
55 master_doc = 'index'
56 
57 # General information about the project.
58 project = u'RiboPlot'
59 copyright = u'2015, Vimalkumar Velayudhan'
60 
61 # The version info for the project you're documenting, acts as replacement
62 # for |version| and |release|, also used in various other places throughout
63 # the built documents.
64 #
65 # The short X.Y version.
66 version = riboplot.__version__
67 # The full version, including alpha/beta/rc tags.
68 release = riboplot.__version__
69 
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
72 #language = None
73 
74 # There are two options for replacing |today|: either, you set today to
75 # some non-false value, then it is used:
76 #today = ''
77 # Else, today_fmt is used as the format for a strftime call.
78 #today_fmt = '%B %d, %Y'
79 
80 # List of patterns, relative to source directory, that match files and
81 # directories to ignore when looking for source files.
82 exclude_patterns = ['_build']
83 
84 # The reST default role (used for this markup: `text`) to use for all
85 # documents.
86 #default_role = None
87 
88 # If true, '()' will be appended to :func: etc. cross-reference text.
89 #add_function_parentheses = True
90 
91 # If true, the current module name will be prepended to all description
92 # unit titles (such as .. function::).
93 #add_module_names = True
94 
95 # If true, sectionauthor and moduleauthor directives will be shown in the
96 # output. They are ignored by default.
97 #show_authors = False
98 
99 # The name of the Pygments (syntax highlighting) style to use.
00 pygments_style = 'sphinx'
01 
02 # A list of ignored prefixes for module index sorting.
03 #modindex_common_prefix = []
04 
05 # If true, keep warnings as "system message" paragraphs in the built
06 # documents.
07 #keep_warnings = False
08 
09 
10 # -- Options for HTML output -------------------------------------------
11 
12 # The theme to use for HTML and HTML Help pages.  See the documentation for
13 # a list of builtin themes.
14 html_theme = 'alabaster'
15 
16 # Theme options are theme-specific and customize the look and feel of a
17 # theme further.  For a list of options available for each theme, see the
18 # documentation.
19 #html_theme_options = {}
20 html_theme_options = {
21         'font_family': '"Source Sans Pro", Ubuntu, sans-serif',
22         'head_font_family': 'Cabin, Ubuntu, sans-serif',
23         'code_font_family': '"Source Code Pro", "Ubuntu Mono", monospace',
24         'code_font_size': '0.8em',
25         'pre_bg': '#f9f9f9', 'note_bg': '#e6f7ff', 'note_border': '#ccefff',
26         'sidebar_list': '#777777', 'body_text': '#515151', 'show_powered_by': False}
27 
28 
29 # Add any paths that contain custom themes here, relative to this directory.
30 #html_theme_path = []
31 
32 # The name for this set of Sphinx documents.  If None, it defaults to
33 # "<project> v<release> documentation".
34 #html_title = None
35 
36 # A shorter title for the navigation bar.  Default is the same as
37 # html_title.
38 #html_short_title = None
39 
40 # The name of an image file (relative to this directory) to place at the
41 # top of the sidebar.
42 #html_logo = None
43 
44 # The name of an image file (within the static path) to use as favicon
45 # of the docs.  This file should be a Windows icon file (.ico) being
46 # 16x16 or 32x32 pixels large.
47 #html_favicon = None
48 
49 # Add any paths that contain custom static files (such as style sheets)
50 # here, relative to this directory. They are copied after the builtin
51 # static files, so a file named "default.css" will overwrite the builtin
52 # "default.css".
53 html_static_path = ['_static']
54 
55 # If not '', a 'Last updated on:' timestamp is inserted at every page
56 # bottom, using the given strftime format.
57 #html_last_updated_fmt = '%b %d, %Y'
58 
59 # If true, SmartyPants will be used to convert quotes and dashes to
60 # typographically correct entities.
61 #html_use_smartypants = True
62 
63 # Custom sidebar templates, maps document names to template names.
64 #html_sidebars = {}
65 
66 # Additional templates that should be rendered to pages, maps page names
67 # to template names.
68 #html_additional_pages = {}
69 
70 # If false, no module index is generated.
71 #html_domain_indices = True
72 
73 # If false, no index is generated.
74 #html_use_index = True
75 
76 # If true, the index is split into individual pages for each letter.
77 #html_split_index = False
78 
79 # If true, links to the reST sources are added to the pages.
80 #html_show_sourcelink = True
81 
82 # If true, "Created using Sphinx" is shown in the HTML footer.
83 # Default is True.
84 #html_show_sphinx = True
85 
86 # If true, "(C) Copyright ..." is shown in the HTML footer.
87 # Default is True.
88 #html_show_copyright = True
89 
90 # If true, an OpenSearch description file will be output, and all pages
91 # will contain a <link> tag referring to it.  The value of this option
92 # must be the base URL from which the finished HTML is served.
93 #html_use_opensearch = ''
94 
95 # This is the file name suffix for HTML files (e.g. ".xhtml").
96 #html_file_suffix = None
97 
98 # Output file base name for HTML help builder.
99 htmlhelp_basename = 'riboplotdoc'
00 
01 
02 # -- Options for LaTeX output ------------------------------------------
03 
04 latex_elements = {
05     # The paper size ('letterpaper' or 'a4paper').
06     #'papersize': 'letterpaper',
07 
08     # The font size ('10pt', '11pt' or '12pt').
09     #'pointsize': '10pt',
10 
11     # Additional stuff for the LaTeX preamble.
12     #'preamble': '',
13 }
14 
15 # Grouping the document tree into LaTeX files. List of tuples
16 # (source start file, target name, title, author, documentclass
17 # [howto/manual]).
18 latex_documents = [
19     ('index', 'riboplot.tex',
20      u'RiboPlot Documentation',
21      u'Vimalkumar Velayudhan', 'manual'),
22 ]
23 
24 # The name of an image file (relative to this directory) to place at
25 # the top of the title page.
26 #latex_logo = None
27 
28 # For "manual" documents, if this is true, then toplevel headings
29 # are parts, not chapters.
30 #latex_use_parts = False
31 
32 # If true, show page references after internal links.
33 #latex_show_pagerefs = False
34 
35 # If true, show URL addresses after external links.
36 #latex_show_urls = False
37 
38 # Documents to append as an appendix to all manuals.
39 #latex_appendices = []
40 
41 # If false, no module index is generated.
42 #latex_domain_indices = True
43 
44 
45 # -- Options for manual page output ------------------------------------
46 
47 # One entry per manual page. List of tuples
48 # (source start file, name, description, authors, manual section).
49 man_pages = [
50     ('index', 'riboplot',
51      u'RiboPlot Documentation',
52      [u'Vimalkumar Velayudhan'], 1)
53 ]
54 
55 # If true, show URL addresses after external links.
56 #man_show_urls = False
57 
58 
59 # -- Options for Texinfo output ----------------------------------------
60 
61 # Grouping the document tree into Texinfo files. List of tuples
62 # (source start file, target name, title, author,
63 #  dir menu entry, description, category)
64 texinfo_documents = [
65     ('index', 'riboplot',
66      u'RiboPlot Documentation',
67      u'Vimalkumar Velayudhan',
68      'riboplot',
69      'One line description of project.',
70      'Miscellaneous'),
71 ]
72 
73 # Documents to append as an appendix to all manuals.
74 #texinfo_appendices = []
75 
76 # If false, no module index is generated.
77 #texinfo_domain_indices = True
78 
79 # How to display URL addresses: 'footnote', 'no', or 'inline'.
80 #texinfo_show_urls = 'footnote'
81 
82 # If true, do not generate a @detailmenu in the "Top" node's menu.
83 #texinfo_no_detailmenu = False