Mercurial > js4py

annotate core-javascript/conf.py @ 213:0ea90a1819c2 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Custom theming
author Radomir Dopieralski <radomir.dopieralski@allegro.pl>
date Wed, 27 Jun 2012 16:35:54 +0200
parents 7b81c64941f9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
97
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
1 # -*- coding: utf-8 -*-
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
2 #
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
3 # Core JavaScript documentation build configuration file, created by
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
4 # sphinx-quickstart on Wed Oct 19 11:43:46 2011.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
5 #
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
6 # This file is execfile()d with the current directory set to its containing dir.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
7 #
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
8 # Note that not all possible configuration values are present in this
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
9 # autogenerated file.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
10 #
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
11 # All configuration values have a default; values that are commented out
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
12 # serve to show the default.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
13
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
14 import sys, os
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
15
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
16 # If extensions (or modules to document with autodoc) are in another directory,
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
17 # add these directories to sys.path here. If the directory is relative to the
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
19 #sys.path.insert(0, os.path.abspath('.'))
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
20
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
21 # -- General configuration -----------------------------------------------------
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
22
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
23 # If your documentation needs a minimal Sphinx version, state it here.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
24 #needs_sphinx = '1.0'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
25
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
26 # Add any Sphinx extension module names here, as strings. They can be extensions
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
28 extensions = []
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
29
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
30 # Add any paths that contain templates here, relative to this directory.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
31 templates_path = ['_templates']
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
32
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
33 # The suffix of source filenames.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
34 source_suffix = '.rst'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
35
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
36 # The encoding of source files.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
37 #source_encoding = 'utf-8-sig'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
38
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
39 # The master toctree document.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
40 master_doc = 'index'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
41
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
42 # General information about the project.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
43 project = u'Core JavaScript'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
44 copyright = u'2011, Jonathan Fine'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
45
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
46 # The version info for the project you're documenting, acts as replacement for
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
47 # |version| and |release|, also used in various other places throughout the
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
48 # built documents.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
49 #
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
50 # The short X.Y version.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
51 version = '0.0'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
52 # The full version, including alpha/beta/rc tags.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
53 release = '0.0'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
54
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
55 # The language for content autogenerated by Sphinx. Refer to documentation
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
56 # for a list of supported languages.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
57 #language = None
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
58
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
59 # There are two options for replacing |today|: either, you set today to some
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
60 # non-false value, then it is used:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
61 #today = ''
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
62 # Else, today_fmt is used as the format for a strftime call.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
63 #today_fmt = '%B %d, %Y'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
64
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
65 # List of patterns, relative to source directory, that match files and
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
66 # directories to ignore when looking for source files.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
67 exclude_patterns = ['_build']
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
68
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
69 # The reST default role (used for this markup: `text`) to use for all documents.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
70 #default_role = None
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
71
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
72 # If true, '()' will be appended to :func: etc. cross-reference text.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
73 #add_function_parentheses = True
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
74
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
75 # If true, the current module name will be prepended to all description
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
76 # unit titles (such as .. function::).
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
77 #add_module_names = True
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
78
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
79 # If true, sectionauthor and moduleauthor directives will be shown in the
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
80 # output. They are ignored by default.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
81 #show_authors = False
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
82
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
83 # The name of the Pygments (syntax highlighting) style to use.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
84 pygments_style = 'sphinx'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
85
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
86 # A list of ignored prefixes for module index sorting.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
87 #modindex_common_prefix = []
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
88
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
89
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
90 # -- Options for HTML output ---------------------------------------------------
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
91
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
92 # The theme to use for HTML and HTML Help pages. See the documentation for
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
93 # a list of builtin themes.
213
0ea90a1819c2 Custom theming
Radomir Dopieralski <radomir.dopieralski@allegro.pl>
parents: 104
diff changeset
94 html_theme = 'bs'
97
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
95
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
96 # Theme options are theme-specific and customize the look and feel of a theme
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
97 # further. For a list of options available for each theme, see the
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
98 # documentation.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
99 #html_theme_options = {}
213
0ea90a1819c2 Custom theming
Radomir Dopieralski <radomir.dopieralski@allegro.pl>
parents: 104
diff changeset
100 html_theme_options = {
0ea90a1819c2 Custom theming
Radomir Dopieralski <radomir.dopieralski@allegro.pl>
parents: 104
diff changeset
101 # Add links to the main menu
0ea90a1819c2 Custom theming
Radomir Dopieralski <radomir.dopieralski@allegro.pl>
parents: 104
diff changeset
102 'main_menu': [('Core', 'index')],
0ea90a1819c2 Custom theming
Radomir Dopieralski <radomir.dopieralski@allegro.pl>
parents: 104
diff changeset
103 'main_menu': [('js2py', '../index')],
0ea90a1819c2 Custom theming
Radomir Dopieralski <radomir.dopieralski@allegro.pl>
parents: 104
diff changeset
104 'selected': '',
0ea90a1819c2 Custom theming
Radomir Dopieralski <radomir.dopieralski@allegro.pl>
parents: 104
diff changeset
105 }
97
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
106
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
107 # Add any paths that contain custom themes here, relative to this directory.
213
0ea90a1819c2 Custom theming
Radomir Dopieralski <radomir.dopieralski@allegro.pl>
parents: 104
diff changeset
108 html_theme_path = ['../themes']
97
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
109
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
110 # The name for this set of Sphinx documents. If None, it defaults to
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
111 # "<project> v<release> documentation".
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
112 #html_title = None
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
113
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
114 # A shorter title for the navigation bar. Default is the same as html_title.
213
0ea90a1819c2 Custom theming
Radomir Dopieralski <radomir.dopieralski@allegro.pl>
parents: 104
diff changeset
115 html_short_title = 'js4py'
97
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
116
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
117 # The name of an image file (relative to this directory) to place at the top
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
118 # of the sidebar.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
119 #html_logo = None
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
120
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
121 # The name of an image file (within the static path) to use as favicon of the
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
122 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
123 # pixels large.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
124 #html_favicon = None
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
125
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
126 # Add any paths that contain custom static files (such as style sheets) here,
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
127 # relative to this directory. They are copied after the builtin static files,
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
128 # so a file named "default.css" will overwrite the builtin "default.css".
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
129 html_static_path = ['_static']
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
130
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
131 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
132 # using the given strftime format.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
133 #html_last_updated_fmt = '%b %d, %Y'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
134
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
135 # If true, SmartyPants will be used to convert quotes and dashes to
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
136 # typographically correct entities.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
137 #html_use_smartypants = True
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
138
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
139 # Custom sidebar templates, maps document names to template names.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
140 #html_sidebars = {}
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
141
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
142 # Additional templates that should be rendered to pages, maps page names to
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
143 # template names.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
144 #html_additional_pages = {}
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
145
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
146 # If false, no module index is generated.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
147 #html_domain_indices = True
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
148
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
149 # If false, no index is generated.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
150 #html_use_index = True
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
151
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
152 # If true, the index is split into individual pages for each letter.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
153 #html_split_index = False
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
154
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
155 # If true, links to the reST sources are added to the pages.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
156 #html_show_sourcelink = True
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
157
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
158 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
159 #html_show_sphinx = True
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
160
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
161 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
162 #html_show_copyright = True
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
163
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
164 # If true, an OpenSearch description file will be output, and all pages will
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
165 # contain a <link> tag referring to it. The value of this option must be the
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
166 # base URL from which the finished HTML is served.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
167 #html_use_opensearch = ''
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
168
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
169 # This is the file name suffix for HTML files (e.g. ".xhtml").
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
170 #html_file_suffix = None
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
171
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
172 # Output file base name for HTML help builder.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
173 htmlhelp_basename = 'CoreJavaScriptdoc'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
174
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
175
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
176 # -- Options for LaTeX output --------------------------------------------------
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
177
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
178 # The paper size ('letter' or 'a4').
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
179 #latex_paper_size = 'letter'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
180
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
181 # The font size ('10pt', '11pt' or '12pt').
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
182 #latex_font_size = '10pt'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
183
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
184 # Grouping the document tree into LaTeX files. List of tuples
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
185 # (source start file, target name, title, author, documentclass [howto/manual]).
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
186 latex_documents = [
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
187 ('index', 'CoreJavaScript.tex', u'Core JavaScript Documentation',
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
188 u'Jonathan Fine', 'manual'),
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
189 ]
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
190
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
191 # The name of an image file (relative to this directory) to place at the top of
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
192 # the title page.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
193 #latex_logo = None
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
194
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
195 # For "manual" documents, if this is true, then toplevel headings are parts,
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
196 # not chapters.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
197 #latex_use_parts = False
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
198
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
199 # If true, show page references after internal links.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
200 #latex_show_pagerefs = False
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
201
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
202 # If true, show URL addresses after external links.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
203 #latex_show_urls = False
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
204
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
205 # Additional stuff for the LaTeX preamble.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
206 #latex_preamble = ''
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
207
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
208 # Documents to append as an appendix to all manuals.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
209 #latex_appendices = []
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
210
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
211 # If false, no module index is generated.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
212 #latex_domain_indices = True
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
213
104
7b81c64941f9 Make a start on global.rst (more work required).
jf3243
parents: 97
diff changeset
214 # Added at the end of the \documentclass[options]{...}.
7b81c64941f9 Make a start on global.rst (more work required).
jf3243
parents: 97
diff changeset
215 # 'english' added to keep Babel quiet.
7b81c64941f9 Make a start on global.rst (more work required).
jf3243
parents: 97
diff changeset
216 # http://groups.google.com/group/sphinx-dev/browse_thread/thread/ee301b14175ad5bb/c06c6600192a17da
7b81c64941f9 Make a start on global.rst (more work required).
jf3243
parents: 97
diff changeset
217 latex_elements = {
7b81c64941f9 Make a start on global.rst (more work required).
jf3243
parents: 97
diff changeset
218 'classoptions': ',openany,english',
7b81c64941f9 Make a start on global.rst (more work required).
jf3243
parents: 97
diff changeset
219 }
97
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
220
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
221 # -- Options for manual page output --------------------------------------------
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
222
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
223 # One entry per manual page. List of tuples
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
224 # (source start file, name, description, authors, manual section).
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
225 man_pages = [
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
226 ('index', 'corejavascript', u'Core JavaScript Documentation',
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
227 [u'Jonathan Fine'], 1)
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
228 ]
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
229
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
230
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
231 # -- Options for Epub output ---------------------------------------------------
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
232
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
233 # Bibliographic Dublin Core info.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
234 epub_title = u'Core JavaScript'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
235 epub_author = u'Jonathan Fine'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
236 epub_publisher = u'Jonathan Fine'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
237 epub_copyright = u'2011, Jonathan Fine'
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
238
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
239 # The language of the text. It defaults to the language option
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
240 # or en if the language is not set.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
241 #epub_language = ''
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
242
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
243 # The scheme of the identifier. Typical schemes are ISBN or URL.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
244 #epub_scheme = ''
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
245
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
246 # The unique identifier of the text. This can be a ISBN number
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
247 # or the project homepage.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
248 #epub_identifier = ''
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
249
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
250 # A unique identification for the text.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
251 #epub_uid = ''
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
252
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
253 # HTML files that should be inserted before the pages created by sphinx.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
254 # The format is a list of tuples containing the path and title.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
255 #epub_pre_files = []
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
256
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
257 # HTML files shat should be inserted after the pages created by sphinx.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
258 # The format is a list of tuples containing the path and title.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
259 #epub_post_files = []
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
260
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
261 # A list of files that should not be packed into the epub file.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
262 #epub_exclude_files = []
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
263
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
264 # The depth of the table of contents in toc.ncx.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
265 #epub_tocdepth = 3
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
266
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
267 # Allow duplicate toc entries.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
268 #epub_tocdup = True