1
# -*- coding: utf-8 -*-
3
# Tesseract-OCR documentation build configuration file, created by
4
# sphinx-quickstart on Thu Nov 10 20:56:36 2011.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
16
# If extensions (or modules to document with autodoc) are in another directory,
17
# add these directories to sys.path here. If the directory is relative to the
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
19
#sys.path.insert(0, os.path.abspath('.'))
21
# -- General configuration -----------------------------------------------------
23
# If your documentation needs a minimal Sphinx version, state it here.
27
# Add any Sphinx extension module names here, as strings. They can be extensions
28
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29
extensions = ['sphinx.ext.todo']
31
# Add any paths that contain templates here, relative to this directory.
32
templates_path = ['_templates']
34
# The suffix of source filenames.
35
source_suffix = '.rst'
37
# The encoding of source files.
38
#source_encoding = 'utf-8-sig'
40
# The master toctree document.
43
# General information about the project.
44
project = u'Tesseract-OCR Visual Studio 2008'
47
# The version info for the project you're documenting, acts as replacement for
48
# |version| and |release|, also used in various other places throughout the
51
# The short X.Y version.
53
# The full version, including alpha/beta/rc tags.
56
# The language for content autogenerated by Sphinx. Refer to documentation
57
# for a list of supported languages.
60
# There are two options for replacing |today|: either, you set today to some
61
# non-false value, then it is used:
63
# Else, today_fmt is used as the format for a strftime call.
64
#today_fmt = '%B %d, %Y'
66
# List of patterns, relative to source directory, that match files and
67
# directories to ignore when looking for source files.
68
exclude_patterns = ['_build']
70
# The reST default role (used for this markup: `text`) to use for all documents.
73
# If true, '()' will be appended to :func: etc. cross-reference text.
74
#add_function_parentheses = True
76
# If true, the current module name will be prepended to all description
77
# unit titles (such as .. function::).
78
#add_module_names = True
80
# If true, sectionauthor and moduleauthor directives will be shown in the
81
# output. They are ignored by default.
84
# The name of the Pygments (syntax highlighting) style to use.
85
pygments_style = 'sphinx'
87
# A list of ignored prefixes for module index sorting.
88
#modindex_common_prefix = []
90
# Have to turn off default python highlight language because otherwise
91
# sometimes NO highlighting is done if line ends with \ char.
92
highlight_language = "none"
95
# -- Options for HTML output ---------------------------------------------------
97
# The theme to use for HTML and HTML Help pages. See the documentation for
98
# a list of builtin themes.
99
#html_theme = 'default'
100
html_theme = 'tesseracttheme'
102
# Theme options are theme-specific and customize the look and feel of a theme
103
# further. For a list of options available for each theme, see the
105
#html_theme_options = {}
107
# Add any paths that contain custom themes here, relative to this directory.
108
#html_theme_path = []
109
html_theme_path = [ "" ]
111
# The name for this set of Sphinx documents. If None, it defaults to
112
# "<project> v<release> documentation".
114
html_title = "Visual Studio 2008 Developer Notes for Tesseract-OCR"
116
# A shorter title for the navigation bar. Default is the same as html_title.
117
#html_short_title = None
118
html_short_title = "Visual Studio 2008 Developer Notes"
120
# The name of an image file (relative to this directory) to place at the top
124
# The name of an image file (within the static path) to use as favicon of the
125
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
129
# Add any paths that contain custom static files (such as style sheets) here,
130
# relative to this directory. They are copied after the builtin static files,
131
# so a file named "default.css" will overwrite the builtin "default.css".
132
html_static_path = ['_static']
134
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
135
# using the given strftime format.
136
#html_last_updated_fmt = '%b %d, %Y'
138
# If true, SmartyPants will be used to convert quotes and dashes to
139
# typographically correct entities.
140
#html_use_smartypants = True
142
# Custom sidebar templates, maps document names to template names.
145
'**' : ['globaltoc.html',
151
# Additional templates that should be rendered to pages, maps page names to
153
#html_additional_pages = {}
155
# If false, no module index is generated.
156
#html_domain_indices = True
157
html_domain_indices = False
159
# If false, no index is generated.
160
#html_use_index = True
161
html_use_index = False
163
# If true, the index is split into individual pages for each letter.
164
#html_split_index = False
166
# If true, links to the reST sources are added to the pages.
167
#html_show_sourcelink = True
168
html_show_sourcelink = False
170
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
171
#html_show_sphinx = True
173
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
174
#html_show_copyright = True
175
html_show_copyright = False
177
# If true, an OpenSearch description file will be output, and all pages will
178
# contain a <link> tag referring to it. The value of this option must be the
179
# base URL from which the finished HTML is served.
180
#html_use_opensearch = ''
182
# This is the file name suffix for HTML files (e.g. ".xhtml").
183
#html_file_suffix = None
185
# Output file base name for HTML help builder.
186
htmlhelp_basename = 'TesseractOCRdoc'
192
.. role:: bi(emphasis)
195
.. role:: raw-html(raw)
201
.. |libtess| replace:: :fs:`libtesseract`
203
.. |liblept| replace:: :fs:`liblept`
205
.. |Leptonica| replace:: :strong:`Leptonica`
207
.. |Tesseractocr| replace:: :strong:`Tesseract-OCR`
209
.. |BuildFolder| replace:: :fs:`BuildFolder`
211
.. |BR| replace:: :raw-html:`<br />`
215
html_compact_lists = False
217
# -- Options for LaTeX output --------------------------------------------------
220
# The paper size ('letterpaper' or 'a4paper').
221
#'papersize': 'letterpaper',
223
# The font size ('10pt', '11pt' or '12pt').
224
#'pointsize': '10pt',
226
# Additional stuff for the LaTeX preamble.
230
# Grouping the document tree into LaTeX files. List of tuples
231
# (source start file, target name, title, author, documentclass [howto/manual]).
233
('index', 'Tesseract-OCR.tex', u'Tesseract-OCR Documentation',
237
# The name of an image file (relative to this directory) to place at the top of
241
# For "manual" documents, if this is true, then toplevel headings are parts,
243
#latex_use_parts = False
245
# If true, show page references after internal links.
246
#latex_show_pagerefs = False
248
# If true, show URL addresses after external links.
249
#latex_show_urls = False
251
# Documents to append as an appendix to all manuals.
252
#latex_appendices = []
254
# If false, no module index is generated.
255
#latex_domain_indices = True
258
# -- Options for manual page output --------------------------------------------
260
# One entry per manual page. List of tuples
261
# (source start file, name, description, authors, manual section).
263
('index', 'tesseract-OCR', u'Tesseract-OCR Documentation',
267
# If true, show URL addresses after external links.
268
#man_show_urls = False
271
# -- Options for Texinfo output ------------------------------------------------
273
# Grouping the document tree into Texinfo files. List of tuples
274
# (source start file, target name, title, author,
275
# dir menu entry, description, category)
276
texinfo_documents = [
277
('index', 'Tesseract-OCR', u'Tesseract-OCR Documentation',
278
u'', 'TesseractOCRDocumentation', 'One line description of project.',
282
# Documents to append as an appendix to all manuals.
283
#texinfo_appendices = []
285
# If false, no module index is generated.
286
#texinfo_domain_indices = True
288
# How to display URL addresses: 'footnote', 'no', or 'inline'.
289
#texinfo_show_urls = 'footnote'
added
removed
vs2008/sphinx/conf.py
