Mercurial > repos > melissacline > ucsc_xena_platform
comparison lockfile-0.10.2/doc/source/conf.py @ 33:7ceb967147c3
start xena with no gui
add library files
author | jingchunzhu <jingchunzhu@gmail.com> |
---|---|
date | Wed, 22 Jul 2015 13:24:44 -0700 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
32:63b1ba1e3424 | 33:7ceb967147c3 |
---|---|
1 # -*- coding: utf-8 -*- | |
2 # | |
3 # lockfile documentation build configuration file, created by | |
4 # sphinx-quickstart on Sat Sep 13 17:54:17 2008. | |
5 # | |
6 # This file is execfile()d with the current directory set to its containing dir. | |
7 # | |
8 # The contents of this file are pickled, so don't put values in the namespace | |
9 # that aren't pickleable (module imports are okay, they're removed automatically). | |
10 # | |
11 # All configuration values have a default value; values that are commented out | |
12 # serve to show the default value. | |
13 | |
14 import sys, os | |
15 | |
16 # If your extensions are in another directory, add it here. If the directory | |
17 # is relative to the documentation root, use os.path.abspath to make it | |
18 # absolute, like shown here. | |
19 #sys.path.append(os.path.abspath('some/directory')) | |
20 | |
21 # General configuration | |
22 # --------------------- | |
23 | |
24 # Add any Sphinx extension module names here, as strings. They can be extensions | |
25 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |
26 extensions = [] | |
27 | |
28 # Add any paths that contain templates here, relative to this directory. | |
29 templates_path = ['.templates'] | |
30 | |
31 # The suffix of source filenames. | |
32 source_suffix = '.rst' | |
33 | |
34 # The master toctree document. | |
35 master_doc = 'index' | |
36 | |
37 # General substitutions. | |
38 project = 'lockfile' | |
39 copyright = '2008, Skip Montanaro' | |
40 | |
41 # The default replacements for |version| and |release|, also used in various | |
42 # other places throughout the built documents. | |
43 # | |
44 # The short X.Y version. | |
45 version = '0.3' | |
46 # The full version, including alpha/beta/rc tags. | |
47 release = '0.3' | |
48 | |
49 # There are two options for replacing |today|: either, you set today to some | |
50 # non-false value, then it is used: | |
51 #today = '' | |
52 # Else, today_fmt is used as the format for a strftime call. | |
53 today_fmt = '%B %d, %Y' | |
54 | |
55 # List of documents that shouldn't be included in the build. | |
56 #unused_docs = [] | |
57 | |
58 # List of directories, relative to source directories, that shouldn't be searched | |
59 # for source files. | |
60 #exclude_dirs = [] | |
61 | |
62 # The reST default role (used for this markup: `text`) to use for all documents. | |
63 #default_role = None | |
64 | |
65 # If true, '()' will be appended to :func: etc. cross-reference text. | |
66 #add_function_parentheses = True | |
67 | |
68 # If true, the current module name will be prepended to all description | |
69 # unit titles (such as .. function::). | |
70 #add_module_names = True | |
71 | |
72 # If true, sectionauthor and moduleauthor directives will be shown in the | |
73 # output. They are ignored by default. | |
74 #show_authors = False | |
75 | |
76 # The name of the Pygments (syntax highlighting) style to use. | |
77 pygments_style = 'sphinx' | |
78 | |
79 | |
80 # Options for HTML output | |
81 # ----------------------- | |
82 | |
83 # The style sheet to use for HTML and HTML Help pages. A file of that name | |
84 # must exist either in Sphinx' static/ path, or in one of the custom paths | |
85 # given in html_static_path. | |
86 html_style = 'default.css' | |
87 | |
88 # The name for this set of Sphinx documents. If None, it defaults to | |
89 # "<project> v<release> documentation". | |
90 #html_title = None | |
91 | |
92 # A shorter title for the navigation bar. Default is the same as html_title. | |
93 #html_short_title = None | |
94 | |
95 # The name of an image file (within the static path) to place at the top of | |
96 # the sidebar. | |
97 #html_logo = None | |
98 | |
99 # The name of an image file (within the static path) to use as favicon of the | |
100 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | |
101 # pixels large. | |
102 #html_favicon = None | |
103 | |
104 # Add any paths that contain custom static files (such as style sheets) here, | |
105 # relative to this directory. They are copied after the builtin static files, | |
106 # so a file named "default.css" will overwrite the builtin "default.css". | |
107 #html_static_path = ['.static'] | |
108 | |
109 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
110 # using the given strftime format. | |
111 html_last_updated_fmt = '%b %d, %Y' | |
112 | |
113 # If true, SmartyPants will be used to convert quotes and dashes to | |
114 # typographically correct entities. | |
115 #html_use_smartypants = True | |
116 | |
117 # Custom sidebar templates, maps document names to template names. | |
118 #html_sidebars = {} | |
119 | |
120 # Additional templates that should be rendered to pages, maps page names to | |
121 # template names. | |
122 #html_additional_pages = {} | |
123 | |
124 # If false, no module index is generated. | |
125 #html_use_modindex = True | |
126 | |
127 # If false, no index is generated. | |
128 #html_use_index = True | |
129 | |
130 # If true, the index is split into individual pages for each letter. | |
131 #html_split_index = False | |
132 | |
133 # If true, the reST sources are included in the HTML build as _sources/<name>. | |
134 #html_copy_source = True | |
135 | |
136 # If true, an OpenSearch description file will be output, and all pages will | |
137 # contain a <link> tag referring to it. The value of this option must be the | |
138 # base URL from which the finished HTML is served. | |
139 #html_use_opensearch = '' | |
140 | |
141 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | |
142 #html_file_suffix = '' | |
143 | |
144 # Output file base name for HTML help builder. | |
145 htmlhelp_basename = 'lockfiledoc' | |
146 | |
147 | |
148 # Options for LaTeX output | |
149 # ------------------------ | |
150 | |
151 # The paper size ('letter' or 'a4'). | |
152 #latex_paper_size = 'letter' | |
153 | |
154 # The font size ('10pt', '11pt' or '12pt'). | |
155 #latex_font_size = '10pt' | |
156 | |
157 # Grouping the document tree into LaTeX files. List of tuples | |
158 # (source start file, target name, title, author, document class [howto/manual]). | |
159 latex_documents = [ | |
160 ('lockfile', 'lockfile.tex', 'lockfile Documentation', | |
161 'Skip Montanaro', 'manual'), | |
162 ] | |
163 | |
164 # The name of an image file (relative to this directory) to place at the top of | |
165 # the title page. | |
166 #latex_logo = None | |
167 | |
168 # For "manual" documents, if this is true, then toplevel headings are parts, | |
169 # not chapters. | |
170 #latex_use_parts = False | |
171 | |
172 # Additional stuff for the LaTeX preamble. | |
173 #latex_preamble = '' | |
174 | |
175 # Documents to append as an appendix to all manuals. | |
176 #latex_appendices = [] | |
177 | |
178 # If false, no module index is generated. | |
179 #latex_use_modindex = True |