amine@23: # -*- coding: utf-8 -*-
amine@23: #
amine@23: # auditok documentation build configuration file, created by
amine@23: # sphinx-quickstart on Mon Sep 21 21:20:14 2015.
amine@23: #
amine@23: # This file is execfile()d with the current directory set to its
amine@23: # containing dir.
amine@23: #
amine@23: # Note that not all possible configuration values are present in this
amine@23: # autogenerated file.
amine@23: #
amine@23: # All configuration values have a default; values that are commented out
amine@23: # serve to show the default.
amine@23: 
amine@404: import ast
amine@367: import re
amine@404: import sys
amine@437: from datetime import datetime
amine@23: 
amine@23: # If extensions (or modules to document with autodoc) are in another directory,
amine@23: # add these directories to sys.path here. If the directory is relative to the
amine@23: # documentation root, use os.path.abspath to make it absolute, like shown here.
amine@331: # sys.path.insert(0, os.path.abspath('.'))
amine@23: 
amine@23: # -- General configuration ------------------------------------------------
amine@23: 
amine@23: # If your documentation needs a minimal Sphinx version, state it here.
amine@331: # needs_sphinx = '1.0'
amine@23: 
amine@23: # Add any Sphinx extension module names here, as strings. They can be
amine@23: # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
amine@23: # ones.
amine@23: extensions = [
amine@367:     "sphinx.ext.napoleon",
amine@331:     "sphinx.ext.viewcode",
amine@331:     "sphinx.ext.autodoc",
amine@331:     "sphinx.ext.autosummary",
amine@23: ]
amine@367: autosummary_generate = True
amine@23: 
amine@367: _version_re = re.compile(r"__version__\s+=\s+(.*)")
amine@367: 
amine@367: with open("../auditok/__init__.py", "rt") as f:
amine@367:     version = str(ast.literal_eval(_version_re.search(f.read()).group(1)))
amine@367:     release = "v" + version
amine@367: 
amine@367: 
amine@367: sys.path.insert(0, "../")
amine@32: 
amine@23: # Add any paths that contain templates here, relative to this directory.
amine@331: templates_path = ["_templates"]
amine@23: 
amine@23: # The suffix(es) of source filenames.
amine@23: # You can specify multiple suffix as a list of string:
amine@23: # source_suffix = ['.rst', '.md']
amine@331: source_suffix = ".rst"
amine@23: 
amine@23: # The encoding of source files.
amine@331: # source_encoding = 'utf-8-sig'
amine@23: 
amine@23: # The master toctree document.
amine@331: master_doc = "index"
amine@23: 
amine@23: # General information about the project.
amine@404: project = "auditok"
amine@437: copyright = f"2015-{datetime.now().year}, Amine Sehili"
amine@404: author = "Amine Sehili"
amine@23: 
amine@23: # The version info for the project you're documenting, acts as replacement for
amine@23: # |version| and |release|, also used in various other places throughout the
amine@23: # built documents.
amine@23: #
amine@23: # The short X.Y version.
amine@367: # version = "0.2.0"
amine@23: # The full version, including alpha/beta/rc tags.
amine@367: # release = "0.2.0"
amine@23: 
amine@23: # The language for content autogenerated by Sphinx. Refer to documentation
amine@23: # for a list of supported languages.
amine@23: #
amine@23: # This is also used if you do content translation via gettext catalogs.
amine@23: # Usually you set "language" from the command line for these cases.
amine@437: language = "en"
amine@23: 
amine@23: # There are two options for replacing |today|: either, you set today to some
amine@23: # non-false value, then it is used:
amine@331: # today = ''
amine@23: # Else, today_fmt is used as the format for a strftime call.
amine@331: # today_fmt = '%B %d, %Y'
amine@23: 
amine@23: # List of patterns, relative to source directory, that match files and
amine@23: # directories to ignore when looking for source files.
amine@331: exclude_patterns = ["_build"]
amine@23: 
amine@23: # The reST default role (used for this markup: `text`) to use for all
amine@23: # documents.
amine@331: # default_role = None
amine@23: 
amine@23: # If true, '()' will be appended to :func: etc. cross-reference text.
amine@331: # add_function_parentheses = True
amine@23: 
amine@23: # If true, the current module name will be prepended to all description
amine@23: # unit titles (such as .. function::).
amine@331: # add_module_names = True
amine@23: 
amine@23: # If true, sectionauthor and moduleauthor directives will be shown in the
amine@23: # output. They are ignored by default.
amine@331: # show_authors = False
amine@23: 
amine@23: # The name of the Pygments (syntax highlighting) style to use.
amine@437: pygments_style = "native"
amine@23: 
amine@23: # A list of ignored prefixes for module index sorting.
amine@331: # modindex_common_prefix = []
amine@23: 
amine@23: # If true, keep warnings as "system message" paragraphs in the built documents.
amine@331: # keep_warnings = False
amine@23: 
amine@23: # If true, `todo` and `todoList` produce output, else they produce nothing.
amine@23: todo_include_todos = False
amine@23: 
amine@23: 
amine@23: # -- Options for HTML output ----------------------------------------------
amine@23: 
amine@23: # The theme to use for HTML and HTML Help pages.  See the documentation for
amine@23: # a list of builtin themes.
amine@437: html_theme = "sphinx_rtd_theme"
amine@32: 
amine@34: 
amine@367: html_theme_options = {
amine@367:     "logo_only": True,
amine@387:     "style_nav_header_background": "#000000",
amine@367: }
amine@35: 
amine@23: # Theme options are theme-specific and customize the look and feel of a theme
amine@23: # further.  For a list of options available for each theme, see the
amine@23: # documentation.
amine@331: # html_theme_options = {}
amine@23: 
amine@23: # Add any paths that contain custom themes here, relative to this directory.
amine@331: # html_theme_path = []
amine@23: 
amine@23: # The name for this set of Sphinx documents.  If None, it defaults to
amine@23: # "<project> v<release> documentation".
amine@331: # html_title = None
amine@23: 
amine@23: # A shorter title for the navigation bar.  Default is the same as html_title.
amine@331: # html_short_title = None
amine@23: 
amine@23: # The name of an image file (relative to this directory) to place at the top
amine@23: # of the sidebar.
amine@367: html_logo = "figures/auditok-logo-rtd.png"
amine@23: 
amine@23: # The name of an image file (within the static path) to use as favicon of the
amine@23: # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
amine@23: # pixels large.
amine@331: # html_favicon = None
amine@23: 
amine@23: # Add any paths that contain custom static files (such as style sheets) here,
amine@23: # relative to this directory. They are copied after the builtin static files,
amine@23: # so a file named "default.css" will overwrite the builtin "default.css".
amine@331: html_static_path = ["_static"]
amine@367: html_css_files = ["css/custom_style.css"]
amine@23: 
amine@23: # Add any extra paths that contain custom files (such as robots.txt or
amine@23: # .htaccess) here, relative to this directory. These files are copied
amine@23: # directly to the root of the documentation.
amine@331: # html_extra_path = []
amine@23: 
amine@23: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
amine@23: # using the given strftime format.
amine@331: # html_last_updated_fmt = '%b %d, %Y'
amine@23: 
amine@23: # If true, SmartyPants will be used to convert quotes and dashes to
amine@23: # typographically correct entities.
amine@331: # html_use_smartypants = True
amine@23: 
amine@23: # Custom sidebar templates, maps document names to template names.
amine@331: # html_sidebars = {}
amine@23: 
amine@23: # Additional templates that should be rendered to pages, maps page names to
amine@23: # template names.
amine@331: # html_additional_pages = {}
amine@23: 
amine@23: # If false, no module index is generated.
amine@331: # html_domain_indices = True
amine@23: 
amine@23: # If false, no index is generated.
amine@331: # html_use_index = True
amine@23: 
amine@23: # If true, the index is split into individual pages for each letter.
amine@331: # html_split_index = False
amine@23: 
amine@23: # If true, links to the reST sources are added to the pages.
amine@331: # html_show_sourcelink = True
amine@23: 
amine@23: # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
amine@331: # html_show_sphinx = True
amine@23: 
amine@23: # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
amine@331: # html_show_copyright = True
amine@23: 
amine@23: # If true, an OpenSearch description file will be output, and all pages will
amine@23: # contain a <link> tag referring to it.  The value of this option must be the
amine@23: # base URL from which the finished HTML is served.
amine@331: # html_use_opensearch = ''
amine@23: 
amine@23: # This is the file name suffix for HTML files (e.g. ".xhtml").
amine@331: # html_file_suffix = None
amine@23: 
amine@23: # Language to be used for generating the HTML full-text search index.
amine@23: # Sphinx supports the following languages:
amine@23: #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
amine@23: #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
amine@331: # html_search_language = 'en'
amine@23: 
amine@23: # A dictionary with options for the search language support, empty by default.
amine@23: # Now only 'ja' uses this config value
amine@331: # html_search_options = {'type': 'default'}
amine@23: 
amine@23: # The name of a javascript file (relative to the configuration directory) that
amine@23: # implements a search results scorer. If empty, the default will be used.
amine@331: # html_search_scorer = 'scorer.js'
amine@23: 
amine@23: # Output file base name for HTML help builder.
amine@331: htmlhelp_basename = "auditokdoc"
amine@23: 
amine@23: # -- Options for LaTeX output ---------------------------------------------
amine@23: 
amine@23: latex_elements = {
amine@331:     # The paper size ('letterpaper' or 'a4paper').
amine@331:     # 'papersize': 'letterpaper',
amine@331:     # The font size ('10pt', '11pt' or '12pt').
amine@331:     # 'pointsize': '10pt',
amine@331:     #  Additional stuff for the LaTeX preamble.
amine@331:     # 'preamble': '',
amine@331:     # Latex figure (float) alignment
amine@331:     # 'figure_align': 'htbp',
amine@23: }
amine@23: 
amine@23: # Grouping the document tree into LaTeX files. List of tuples
amine@23: # (source start file, target name, title,
amine@23: #  author, documentclass [howto, manual, or own class]).
amine@23: latex_documents = [
amine@331:     (
amine@331:         master_doc,
amine@331:         "auditok.tex",
amine@404:         "auditok Documentation",
amine@404:         "Amine Sehili",
amine@331:         "manual",
amine@331:     ),
amine@23: ]
amine@23: 
amine@23: # The name of an image file (relative to this directory) to place at the top of
amine@23: # the title page.
amine@331: # latex_logo = None
amine@23: 
amine@23: # For "manual" documents, if this is true, then toplevel headings are parts,
amine@23: # not chapters.
amine@331: # latex_use_parts = False
amine@23: 
amine@23: # If true, show page references after internal links.
amine@331: # latex_show_pagerefs = False
amine@23: 
amine@23: # If true, show URL addresses after external links.
amine@331: # latex_show_urls = False
amine@23: 
amine@23: # Documents to append as an appendix to all manuals.
amine@331: # latex_appendices = []
amine@23: 
amine@23: # If false, no module index is generated.
amine@331: # latex_domain_indices = True
amine@23: 
amine@23: 
amine@23: # -- Options for manual page output ---------------------------------------
amine@23: 
amine@23: # One entry per manual page. List of tuples
amine@23: # (source start file, name, description, authors, manual section).
amine@404: man_pages = [(master_doc, "auditok", "auditok Documentation", [author], 1)]
amine@23: 
amine@23: # If true, show URL addresses after external links.
amine@331: # man_show_urls = False
amine@23: 
amine@23: 
amine@23: # -- Options for Texinfo output -------------------------------------------
amine@23: 
amine@23: # Grouping the document tree into Texinfo files. List of tuples
amine@23: # (source start file, target name, title, author,
amine@23: #  dir menu entry, description, category)
amine@23: texinfo_documents = [
amine@331:     (
amine@331:         master_doc,
amine@331:         "auditok",
amine@404:         "auditok Documentation",
amine@331:         author,
amine@331:         "auditok",
amine@367:         "Audio Activity Detection tool.",
amine@331:         "Miscellaneous",
amine@331:     ),
amine@23: ]
amine@23: 
amine@23: # Documents to append as an appendix to all manuals.
amine@331: # texinfo_appendices = []
amine@23: 
amine@23: # If false, no module index is generated.
amine@331: # texinfo_domain_indices = True
amine@23: 
amine@23: # How to display URL addresses: 'footnote', 'no', or 'inline'.
amine@331: # texinfo_show_urls = 'footnote'
amine@23: 
amine@23: # If true, do not generate a @detailmenu in the "Top" node's menu.
amine@331: # texinfo_no_detailmenu = False