1 # -*- coding: utf-8 -*-
3 # m_Librarian documentation build configuration file, created by
4 # sphinx-quickstart on Wed Mar 30 22:46:31 2016.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
18 # If extensions (or modules to document with autodoc) are in another directory,
19 # add these directories to sys.path here. If the directory is relative to the
20 # documentation root, use os.path.abspath to make it absolute, like shown here.
21 #sys.path.insert(0, os.path.abspath('.'))
23 # -- General configuration ------------------------------------------------
25 # If your documentation needs a minimal Sphinx version, state it here.
28 # Add any Sphinx extension module names here, as strings. They can be
29 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 # Add any paths that contain templates here, relative to this directory.
34 templates_path = ['_templates']
36 # The suffix of source filenames.
37 source_suffix = '.rst'
39 # The encoding of source files.
40 #source_encoding = 'utf-8-sig'
42 # The master toctree document.
45 # General information about the project.
46 project = u'm_Librarian'
47 copyright = u'2016, Oleg Broytman'
49 # The version info for the project you're documenting, acts as replacement for
50 # |version| and |release|, also used in various other places throughout the
53 sys.path.insert(0, os.path.abspath('..'))
54 from m_librarian.__version__ import __version__
55 # The short X.Y version.
56 version = '.'.join(__version__.split('.')[:2])
57 # The full version, including alpha/beta/rc tags.
60 # The language for content autogenerated by Sphinx. Refer to documentation
61 # for a list of supported languages.
63 # This is also used if you do content translation via gettext catalogs.
64 # Usually you set "language" from the command line for these cases.
67 # There are two options for replacing |today|: either, you set today to some
68 # non-false value, then it is used:
70 # Else, today_fmt is used as the format for a strftime call.
71 #today_fmt = '%B %d, %Y'
73 # List of patterns, relative to source directory, that match files and
74 # directories to ignore when looking for source files.
75 exclude_patterns = ['_build']
77 # The reST default role (used for this markup: `text`) to use for all
81 # If true, '()' will be appended to :func: etc. cross-reference text.
82 #add_function_parentheses = True
84 # If true, the current module name will be prepended to all description
85 # unit titles (such as .. function::).
86 #add_module_names = True
88 # If true, sectionauthor and moduleauthor directives will be shown in the
89 # output. They are ignored by default.
92 # The name of the Pygments (syntax highlighting) style to use.
93 pygments_style = 'sphinx'
95 # A list of ignored prefixes for module index sorting.
96 #modindex_common_prefix = []
98 # If true, keep warnings as "system message" paragraphs in the built documents.
99 #keep_warnings = False
102 # -- Options for HTML output ----------------------------------------------
104 # The theme to use for HTML and HTML Help pages. See the documentation for
105 # a list of builtin themes.
106 html_theme = 'default'
108 # Theme options are theme-specific and customize the look and feel of a theme
109 # further. For a list of options available for each theme, see the
111 #html_theme_options = {}
113 # Add any paths that contain custom themes here, relative to this directory.
114 #html_theme_path = []
116 # The name for this set of Sphinx documents. If None, it defaults to
117 # "<project> v<release> documentation".
120 # A shorter title for the navigation bar. Default is the same as html_title.
121 #html_short_title = None
123 # The name of an image file (relative to this directory) to place at the top
127 # The name of an image file (within the static path) to use as favicon of the
128 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
132 # Add any paths that contain custom static files (such as style sheets) here,
133 # relative to this directory. They are copied after the builtin static files,
134 # so a file named "default.css" will overwrite the builtin "default.css".
135 html_static_path = ['_static']
137 # Add any extra paths that contain custom files (such as robots.txt or
138 # .htaccess) here, relative to this directory. These files are copied
139 # directly to the root of the documentation.
140 #html_extra_path = []
142 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143 # using the given strftime format.
144 #html_last_updated_fmt = '%b %d, %Y'
146 # If true, SmartyPants will be used to convert quotes and dashes to
147 # typographically correct entities.
148 #html_use_smartypants = True
150 # Custom sidebar templates, maps document names to template names.
153 # Additional templates that should be rendered to pages, maps page names to
155 #html_additional_pages = {}
157 # If false, no module index is generated.
158 #html_domain_indices = True
160 # If false, no index is generated.
161 #html_use_index = True
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
169 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
170 #html_show_sphinx = True
172 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
173 #html_show_copyright = True
175 # If true, an OpenSearch description file will be output, and all pages will
176 # contain a <link> tag referring to it. The value of this option must be the
177 # base URL from which the finished HTML is served.
178 #html_use_opensearch = ''
180 # This is the file name suffix for HTML files (e.g. ".xhtml").
181 #html_file_suffix = None
183 # Language to be used for generating the HTML full-text search index.
184 # Sphinx supports the following languages:
185 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
186 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
187 #html_search_language = 'en'
189 # A dictionary with options for the search language support, empty by default.
190 # Now only 'ja' uses this config value
191 #html_search_options = {'type': 'default'}
193 # The name of a javascript file (relative to the configuration directory) that
194 # implements a search results scorer. If empty, the default will be used.
195 #html_search_scorer = 'scorer.js'
197 # Output file base name for HTML help builder.
198 htmlhelp_basename = 'm_librarian_doc'
200 # -- Options for LaTeX output ---------------------------------------------
203 # The paper size ('letterpaper' or 'a4paper').
204 #'papersize': 'letterpaper',
206 # The font size ('10pt', '11pt' or '12pt').
207 #'pointsize': '10pt',
209 # Additional stuff for the LaTeX preamble.
212 # Latex figure (float) alignment
213 #'figure_align': 'htbp',
216 # Grouping the document tree into LaTeX files. List of tuples
217 # (source start file, target name, title,
218 # author, documentclass [howto, manual, or own class]).
220 ('index', 'm_librarian.tex', u'm\\_Librarian Documentation',
221 u'Oleg Broytman', 'manual'),
224 # The name of an image file (relative to this directory) to place at the top of
228 # For "manual" documents, if this is true, then toplevel headings are parts,
230 #latex_use_parts = False
232 # If true, show page references after internal links.
233 #latex_show_pagerefs = False
235 # If true, show URL addresses after external links.
236 #latex_show_urls = False
238 # Documents to append as an appendix to all manuals.
239 #latex_appendices = []
241 # If false, no module index is generated.
242 #latex_domain_indices = True
245 # -- Options for manual page output ---------------------------------------
247 # One entry per manual page. List of tuples
248 # (source start file, name, description, authors, manual section).
250 ('index', 'm_Librarian', u'm_Librarian Documentation',
251 [u'Oleg Broytman'], 1)
254 # If true, show URL addresses after external links.
255 #man_show_urls = False
258 # -- Options for Texinfo output -------------------------------------------
260 # Grouping the document tree into Texinfo files. List of tuples
261 # (source start file, target name, title, author,
262 # dir menu entry, description, category)
263 texinfo_documents = [
264 ('index', 'm_Librarian', u'm_Librarian Documentation',
265 u'Oleg Broytman', 'm_Librarian', 'Broytman Librarian.',
269 # Documents to append as an appendix to all manuals.
270 #texinfo_appendices = []
272 # If false, no module index is generated.
273 #texinfo_domain_indices = True
275 # How to display URL addresses: 'footnote', 'no', or 'inline'.
276 #texinfo_show_urls = 'footnote'
278 # If true, do not generate a @detailmenu in the "Top" node's menu.
279 #texinfo_no_detailmenu = False