Mercurial > repos > vimalkumarvelayudhan > riboplot

annotate docs/conf.py @ 16:ef39290c19af

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Replace docs with include directives (rst)
author Vimalkumar Velayudhan <vimal@biotechcoder.com>
date Thu, 27 Aug 2015 13:03:28 +0100
parents b78a5ba760b1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
1 #!/usr/bin/env python
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
3 #
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
4 # riboplot documentation build configuration file, created by
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
5 # sphinx-quickstart on Tue Jul 9 22:26:36 2013.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
6 #
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
7 # This file is execfile()d with the current directory set to its
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
8 # containing dir.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
9 #
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
10 # Note that not all possible configuration values are present in this
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
11 # autogenerated file.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
12 #
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
13 # All configuration values have a default; values that are commented out
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
14 # serve to show the default.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
15
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
16 import sys
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
17 import os
15
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
18 # To get the docs to build on readthedocs.org
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
19 from mock import Mock as MagicMock
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
20
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
21 class Mock(MagicMock):
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
22 @classmethod
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
23 def __getattr__(cls, name):
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
24 return Mock()
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
25
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
26 MOCK_MODULES = ['matplotlib']
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
27 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
28
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
29
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
30 # If extensions (or modules to document with autodoc) are in another
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
31 # directory, add these directories to sys.path here. If the directory is
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
32 # relative to the documentation root, use os.path.abspath to make it
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
33 # absolute, like shown here.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
34 #sys.path.insert(0, os.path.abspath('.'))
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
35
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
36 # Get the project root dir, which is the parent dir of this
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
37 cwd = os.getcwd()
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
38 project_root = os.path.dirname(cwd)
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
39
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
40 # Insert the project root dir as the first element in the PYTHONPATH.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
41 # This lets us ensure that the source package is imported, and that its
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
42 # version is used.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
43 sys.path.insert(0, project_root)
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
44
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
45 import riboplot
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
46
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
47 # -- General configuration ---------------------------------------------
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
48
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
49 # If your documentation needs a minimal Sphinx version, state it here.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
50 #needs_sphinx = '1.0'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
51
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
52 # Add any Sphinx extension module names here, as strings. They can be
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
53 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
15
b78a5ba760b1 Update README, add new sample image
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 14
diff changeset
54 extensions = ['sphinx.ext.viewcode']
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
55
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
56 # Add any paths that contain templates here, relative to this directory.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
57 templates_path = ['_templates']
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
58
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
59 # The suffix of source filenames.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
60 source_suffix = '.rst'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
61
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
62 # The encoding of source files.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
63 #source_encoding = 'utf-8-sig'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
64
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
65 # The master toctree document.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
66 master_doc = 'index'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
67
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
68 # General information about the project.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
69 project = u'RiboPlot'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
70 copyright = u'2015, Vimalkumar Velayudhan'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
71
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
72 # The version info for the project you're documenting, acts as replacement
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
73 # for |version| and |release|, also used in various other places throughout
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
74 # the built documents.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
75 #
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
76 # The short X.Y version.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
77 version = riboplot.__version__
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
78 # The full version, including alpha/beta/rc tags.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
79 release = riboplot.__version__
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
80
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
81 # The language for content autogenerated by Sphinx. Refer to documentation
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
82 # for a list of supported languages.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
83 #language = None
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
84
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
85 # There are two options for replacing |today|: either, you set today to
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
86 # some non-false value, then it is used:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
87 #today = ''
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
88 # Else, today_fmt is used as the format for a strftime call.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
89 #today_fmt = '%B %d, %Y'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
90
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
91 # List of patterns, relative to source directory, that match files and
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
92 # directories to ignore when looking for source files.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
93 exclude_patterns = ['_build']
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
94
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
95 # The reST default role (used for this markup: `text`) to use for all
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
96 # documents.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
97 #default_role = None
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
98
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
99 # If true, '()' will be appended to :func: etc. cross-reference text.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
100 #add_function_parentheses = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
101
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
102 # If true, the current module name will be prepended to all description
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
103 # unit titles (such as .. function::).
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
104 #add_module_names = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
105
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
106 # If true, sectionauthor and moduleauthor directives will be shown in the
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
107 # output. They are ignored by default.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
108 #show_authors = False
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
109
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
110 # The name of the Pygments (syntax highlighting) style to use.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
111 pygments_style = 'sphinx'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
112
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
113 # A list of ignored prefixes for module index sorting.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
114 #modindex_common_prefix = []
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
115
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
116 # If true, keep warnings as "system message" paragraphs in the built
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
117 # documents.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
118 #keep_warnings = False
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
119
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
120
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
121 # -- Options for HTML output -------------------------------------------
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
122
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
123 # The theme to use for HTML and HTML Help pages. See the documentation for
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
124 # a list of builtin themes.
7
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 3
diff changeset
125 html_theme = 'alabaster'
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
126
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
127 # Theme options are theme-specific and customize the look and feel of a
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
128 # theme further. For a list of options available for each theme, see the
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
129 # documentation.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
130 #html_theme_options = {}
7
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 3
diff changeset
131 html_theme_options = {
8
844eb8c36f32 Add help section in xml and update usage documentation
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
132 'font_family': '"Source Sans Pro", Ubuntu, sans-serif',
844eb8c36f32 Add help section in xml and update usage documentation
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 7
diff changeset
133 'head_font_family': 'Cabin, Ubuntu, sans-serif',
7
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 3
diff changeset
134 'code_font_family': '"Source Code Pro", "Ubuntu Mono", monospace',
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 3
diff changeset
135 'code_font_size': '0.8em',
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 3
diff changeset
136 'pre_bg': '#f9f9f9', 'note_bg': '#e6f7ff', 'note_border': '#ccefff',
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 3
diff changeset
137 'sidebar_list': '#777777', 'body_text': '#515151', 'show_powered_by': False}
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 3
diff changeset
138
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
139
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
140 # Add any paths that contain custom themes here, relative to this directory.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
141 #html_theme_path = []
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
142
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
143 # The name for this set of Sphinx documents. If None, it defaults to
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
144 # "<project> v<release> documentation".
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
145 #html_title = None
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
146
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
147 # A shorter title for the navigation bar. Default is the same as
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
148 # html_title.
14
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 8
diff changeset
149 html_short_title = 'RiboPlot'
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
150
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
151 # The name of an image file (relative to this directory) to place at the
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
152 # top of the sidebar.
14
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 8
diff changeset
153 html_logo = '_static/riboplot-logo.png'
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
154
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
155 # The name of an image file (within the static path) to use as favicon
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
156 # of the docs. This file should be a Windows icon file (.ico) being
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
157 # 16x16 or 32x32 pixels large.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
158 #html_favicon = None
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
159
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
160 # Add any paths that contain custom static files (such as style sheets)
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
161 # here, relative to this directory. They are copied after the builtin
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
162 # static files, so a file named "default.css" will overwrite the builtin
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
163 # "default.css".
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
164 html_static_path = ['_static']
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
165
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
166 # If not '', a 'Last updated on:' timestamp is inserted at every page
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
167 # bottom, using the given strftime format.
14
628f82e72d72 Version as released on PyPI 0.1.0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 8
diff changeset
168 html_last_updated_fmt = '%b %d, %Y'
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
169
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
170 # If true, SmartyPants will be used to convert quotes and dashes to
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
171 # typographically correct entities.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
172 #html_use_smartypants = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
173
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
174 # Custom sidebar templates, maps document names to template names.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
175 #html_sidebars = {}
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
176
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
177 # Additional templates that should be rendered to pages, maps page names
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
178 # to template names.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
179 #html_additional_pages = {}
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
180
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
181 # If false, no module index is generated.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
182 #html_domain_indices = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
183
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
184 # If false, no index is generated.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
185 #html_use_index = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
186
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
187 # If true, the index is split into individual pages for each letter.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
188 #html_split_index = False
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
189
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
190 # If true, links to the reST sources are added to the pages.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
191 #html_show_sourcelink = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
192
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
193 # If true, "Created using Sphinx" is shown in the HTML footer.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
194 # Default is True.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
195 #html_show_sphinx = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
196
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
197 # If true, "(C) Copyright ..." is shown in the HTML footer.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
198 # Default is True.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
199 #html_show_copyright = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
200
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
201 # If true, an OpenSearch description file will be output, and all pages
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
202 # will contain a <link> tag referring to it. The value of this option
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
203 # must be the base URL from which the finished HTML is served.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
204 #html_use_opensearch = ''
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
205
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
206 # This is the file name suffix for HTML files (e.g. ".xhtml").
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
207 #html_file_suffix = None
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
208
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
209 # Output file base name for HTML help builder.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
210 htmlhelp_basename = 'riboplotdoc'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
211
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
212
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
213 # -- Options for LaTeX output ------------------------------------------
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
214
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
215 latex_elements = {
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
216 # The paper size ('letterpaper' or 'a4paper').
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
217 #'papersize': 'letterpaper',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
218
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
219 # The font size ('10pt', '11pt' or '12pt').
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
220 #'pointsize': '10pt',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
221
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
222 # Additional stuff for the LaTeX preamble.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
223 #'preamble': '',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
224 }
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
225
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
226 # Grouping the document tree into LaTeX files. List of tuples
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
227 # (source start file, target name, title, author, documentclass
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
228 # [howto/manual]).
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
229 latex_documents = [
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
230 ('index', 'riboplot.tex',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
231 u'RiboPlot Documentation',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
232 u'Vimalkumar Velayudhan', 'manual'),
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
233 ]
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
234
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
235 # The name of an image file (relative to this directory) to place at
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
236 # the top of the title page.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
237 #latex_logo = None
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
238
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
239 # For "manual" documents, if this is true, then toplevel headings
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
240 # are parts, not chapters.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
241 #latex_use_parts = False
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
242
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
243 # If true, show page references after internal links.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
244 #latex_show_pagerefs = False
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
245
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
246 # If true, show URL addresses after external links.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
247 #latex_show_urls = False
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
248
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
249 # Documents to append as an appendix to all manuals.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
250 #latex_appendices = []
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
251
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
252 # If false, no module index is generated.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
253 #latex_domain_indices = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
254
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
255
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
256 # -- Options for manual page output ------------------------------------
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
257
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
258 # One entry per manual page. List of tuples
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
259 # (source start file, name, description, authors, manual section).
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
260 man_pages = [
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
261 ('index', 'riboplot',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
262 u'RiboPlot Documentation',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
263 [u'Vimalkumar Velayudhan'], 1)
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
264 ]
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
265
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
266 # If true, show URL addresses after external links.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
267 #man_show_urls = False
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
268
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
269
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
270 # -- Options for Texinfo output ----------------------------------------
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
271
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
272 # Grouping the document tree into Texinfo files. List of tuples
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
273 # (source start file, target name, title, author,
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
274 # dir menu entry, description, category)
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
275 texinfo_documents = [
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
276 ('index', 'riboplot',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
277 u'RiboPlot Documentation',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
278 u'Vimalkumar Velayudhan',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
279 'riboplot',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
280 'One line description of project.',
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
281 'Miscellaneous'),
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
282 ]
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
283
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
284 # Documents to append as an appendix to all manuals.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
285 #texinfo_appendices = []
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
286
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
287 # If false, no module index is generated.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
288 #texinfo_domain_indices = True
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
289
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
290 # How to display URL addresses: 'footnote', 'no', or 'inline'.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
291 #texinfo_show_urls = 'footnote'
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
292
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
293 # If true, do not generate a @detailmenu in the "Top" node's menu.
7
096c6bbf4a04 Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents: 3
diff changeset
294 #texinfo_no_detailmenu = False