Mercurial > repos > vimalkumarvelayudhan > riboplot
comparison docs/conf.py @ 3:8e1efafa6277
Updated version
* Bugfix: blue lines in some plots (bar colors were not set correctly)
* Cookiecutter template
* Additional unit tests
* Add plot legend
author | Vimalkumar Velayudhan <vimal@biotechcoder.com> |
---|---|
date | Wed, 12 Aug 2015 09:27:45 +0100 |
parents | |
children | 096c6bbf4a04 |
comparison
equal
deleted
inserted
replaced
2:b6fd86c539ea | 3:8e1efafa6277 |
---|---|
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. | |
100 pygments_style = 'sphinx' | |
101 | |
102 # A list of ignored prefixes for module index sorting. | |
103 #modindex_common_prefix = [] | |
104 | |
105 # If true, keep warnings as "system message" paragraphs in the built | |
106 # documents. | |
107 #keep_warnings = False | |
108 | |
109 | |
110 # -- Options for HTML output ------------------------------------------- | |
111 | |
112 # The theme to use for HTML and HTML Help pages. See the documentation for | |
113 # a list of builtin themes. | |
114 html_theme = 'default' | |
115 | |
116 # Theme options are theme-specific and customize the look and feel of a | |
117 # theme further. For a list of options available for each theme, see the | |
118 # documentation. | |
119 #html_theme_options = {} | |
120 | |
121 # Add any paths that contain custom themes here, relative to this directory. | |
122 #html_theme_path = [] | |
123 | |
124 # The name for this set of Sphinx documents. If None, it defaults to | |
125 # "<project> v<release> documentation". | |
126 #html_title = None | |
127 | |
128 # A shorter title for the navigation bar. Default is the same as | |
129 # html_title. | |
130 #html_short_title = None | |
131 | |
132 # The name of an image file (relative to this directory) to place at the | |
133 # top of the sidebar. | |
134 #html_logo = None | |
135 | |
136 # The name of an image file (within the static path) to use as favicon | |
137 # of the docs. This file should be a Windows icon file (.ico) being | |
138 # 16x16 or 32x32 pixels large. | |
139 #html_favicon = None | |
140 | |
141 # Add any paths that contain custom static files (such as style sheets) | |
142 # here, relative to this directory. They are copied after the builtin | |
143 # static files, so a file named "default.css" will overwrite the builtin | |
144 # "default.css". | |
145 html_static_path = ['_static'] | |
146 | |
147 # If not '', a 'Last updated on:' timestamp is inserted at every page | |
148 # bottom, using the given strftime format. | |
149 #html_last_updated_fmt = '%b %d, %Y' | |
150 | |
151 # If true, SmartyPants will be used to convert quotes and dashes to | |
152 # typographically correct entities. | |
153 #html_use_smartypants = True | |
154 | |
155 # Custom sidebar templates, maps document names to template names. | |
156 #html_sidebars = {} | |
157 | |
158 # Additional templates that should be rendered to pages, maps page names | |
159 # to template names. | |
160 #html_additional_pages = {} | |
161 | |
162 # If false, no module index is generated. | |
163 #html_domain_indices = True | |
164 | |
165 # If false, no index is generated. | |
166 #html_use_index = True | |
167 | |
168 # If true, the index is split into individual pages for each letter. | |
169 #html_split_index = False | |
170 | |
171 # If true, links to the reST sources are added to the pages. | |
172 #html_show_sourcelink = True | |
173 | |
174 # If true, "Created using Sphinx" is shown in the HTML footer. | |
175 # Default is True. | |
176 #html_show_sphinx = True | |
177 | |
178 # If true, "(C) Copyright ..." is shown in the HTML footer. | |
179 # Default is True. | |
180 #html_show_copyright = True | |
181 | |
182 # If true, an OpenSearch description file will be output, and all pages | |
183 # will contain a <link> tag referring to it. The value of this option | |
184 # must be the base URL from which the finished HTML is served. | |
185 #html_use_opensearch = '' | |
186 | |
187 # This is the file name suffix for HTML files (e.g. ".xhtml"). | |
188 #html_file_suffix = None | |
189 | |
190 # Output file base name for HTML help builder. | |
191 htmlhelp_basename = 'riboplotdoc' | |
192 | |
193 | |
194 # -- Options for LaTeX output ------------------------------------------ | |
195 | |
196 latex_elements = { | |
197 # The paper size ('letterpaper' or 'a4paper'). | |
198 #'papersize': 'letterpaper', | |
199 | |
200 # The font size ('10pt', '11pt' or '12pt'). | |
201 #'pointsize': '10pt', | |
202 | |
203 # Additional stuff for the LaTeX preamble. | |
204 #'preamble': '', | |
205 } | |
206 | |
207 # Grouping the document tree into LaTeX files. List of tuples | |
208 # (source start file, target name, title, author, documentclass | |
209 # [howto/manual]). | |
210 latex_documents = [ | |
211 ('index', 'riboplot.tex', | |
212 u'RiboPlot Documentation', | |
213 u'Vimalkumar Velayudhan', 'manual'), | |
214 ] | |
215 | |
216 # The name of an image file (relative to this directory) to place at | |
217 # the top of the title page. | |
218 #latex_logo = None | |
219 | |
220 # For "manual" documents, if this is true, then toplevel headings | |
221 # are parts, not chapters. | |
222 #latex_use_parts = False | |
223 | |
224 # If true, show page references after internal links. | |
225 #latex_show_pagerefs = False | |
226 | |
227 # If true, show URL addresses after external links. | |
228 #latex_show_urls = False | |
229 | |
230 # Documents to append as an appendix to all manuals. | |
231 #latex_appendices = [] | |
232 | |
233 # If false, no module index is generated. | |
234 #latex_domain_indices = True | |
235 | |
236 | |
237 # -- Options for manual page output ------------------------------------ | |
238 | |
239 # One entry per manual page. List of tuples | |
240 # (source start file, name, description, authors, manual section). | |
241 man_pages = [ | |
242 ('index', 'riboplot', | |
243 u'RiboPlot Documentation', | |
244 [u'Vimalkumar Velayudhan'], 1) | |
245 ] | |
246 | |
247 # If true, show URL addresses after external links. | |
248 #man_show_urls = False | |
249 | |
250 | |
251 # -- Options for Texinfo output ---------------------------------------- | |
252 | |
253 # Grouping the document tree into Texinfo files. List of tuples | |
254 # (source start file, target name, title, author, | |
255 # dir menu entry, description, category) | |
256 texinfo_documents = [ | |
257 ('index', 'riboplot', | |
258 u'RiboPlot Documentation', | |
259 u'Vimalkumar Velayudhan', | |
260 'riboplot', | |
261 'One line description of project.', | |
262 'Miscellaneous'), | |
263 ] | |
264 | |
265 # Documents to append as an appendix to all manuals. | |
266 #texinfo_appendices = [] | |
267 | |
268 # If false, no module index is generated. | |
269 #texinfo_domain_indices = True | |
270 | |
271 # How to display URL addresses: 'footnote', 'no', or 'inline'. | |
272 #texinfo_show_urls = 'footnote' | |
273 | |
274 # If true, do not generate a @detailmenu in the "Top" node's menu. | |
275 #texinfo_no_detailmenu = False |