# OpenTURNS documentation build configuration file, created by
# sphinx-quickstart on Wed Mar 12 14:11:36 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import subprocess
from sphinx_gallery.sorting import ExplicitOrder
import sphinx_gallery

try:
    from packaging.version import Version
except ImportError:
    from pkg_resources import parse_version as Version

try:
    import joblib
    have_joblib = True
except ImportError:
    have_joblib = False

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('sphinxext'))
sys.path.insert(0, '@OPENTURNS_PYTHON_BUILD_MODULE_PATH@')

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Create table of contents entries for domain objects
toc_object_entries = False

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []

extensions.append('sphinx.ext.autodoc')
autodoc_default_options = {'members': None, 'inherited-members': None, 'exclude-members': 'thisown'}

extensions.append('sphinx.ext.autosummary')
autosummary_generate = True

extensions.append('execforresourcemap_directive')

extensions.append('numpydoc')
numpydoc_show_class_members = True
numpydoc_class_members_toctree = False

extensions.append('sphinx.ext.doctest')

extensions.append('sphinx.ext.todo')
todo_include_todos = True

extensions.append('sphinx.ext.coverage')

extensions.append('sphinx.ext.intersphinx')
intersphinx_mapping = {'matplotlib': ('https://matplotlib.org/stable/', (None, 'matplotlib-objects.inv'))}

extensions.append('sphinx.ext.imgmath')
imgmath_latex_preamble = r'\usepackage{{{0}math_notations}}'.format(
    os.path.dirname(__file__) + os.sep)
imgmath_use_preview = True
if subprocess.run(["dvisvgm", "-V"], shell=True, capture_output=True).returncode == 0:
    imgmath_image_format = "svg"
# embed image files inside html
imgmath_embed = True

extensions.append('matplotlib.sphinxext.plot_directive')
plot_formats = ['png']

extensions.append('sphinx_copybutton')
copybutton_exclude = '.linenos, .gp'

extensions.append('sphinx_gallery.gen_gallery')
sphinx_gallery_conf = {

     'examples_dirs': ['examples/data_analysis','examples/probabilistic_modeling','examples/meta_modeling','examples/reliability_sensitivity','examples/functional_modeling','examples/calibration','examples/numerical_methods','examples/graphs',], # path to example scripts
     'gallery_dirs': ['auto_data_analysis','auto_probabilistic_modeling','auto_meta_modeling','auto_reliability_sensitivity','auto_functional_modeling','auto_calibration','auto_numerical_methods','auto_graphs',], # path to where to save gallery gen. output


     'filename_pattern': '/plot_',
     'ignore_pattern': '/(external_program)|(__init__.py)|(use_case_)@SPHINX_GALLERY_IGNORE_PATTERN@',


     'subsection_order': ExplicitOrder(['examples/data_analysis/manage_data_and_samples',
                                        'examples/data_analysis/sample_analysis',
                                        'examples/data_analysis/distribution_fitting',
                                        'examples/data_analysis/statistical_tests',
                                        'examples/data_analysis/estimate_dependency_and_copulas',
                                        'examples/data_analysis/estimate_stochastic_processes',
                                        'examples/data_analysis/graphics',
                                        'examples/probabilistic_modeling/distributions',
                                        'examples/probabilistic_modeling/copulas',
                                        'examples/probabilistic_modeling/random_vectors',
                                        'examples/probabilistic_modeling/stochastic_processes',
                                        'examples/meta_modeling/general_purpose_metamodels',
                                        'examples/meta_modeling/polynomial_chaos_metamodel',
                                        'examples/meta_modeling/kriging_metamodel',
                                        'examples/meta_modeling/low_rank_tensors_metamodel',
                                        'examples/meta_modeling/fields_metamodels',
                                        'examples/reliability_sensitivity/central_dispersion',
                                        'examples/reliability_sensitivity/reliability',
                                        'examples/reliability_sensitivity/reliability_processes',
                                        'examples/reliability_sensitivity/sensitivity_analysis',
                                        'examples/reliability_sensitivity/design_of_experiments',
                                        'examples/functional_modeling/univariate_functions',
                                        'examples/functional_modeling/vectorial_functions',
                                        'examples/functional_modeling/functional_basis',
                                        'examples/functional_modeling/field_functions',
                                        'examples/functional_modeling/link_to_an_external_code',
                                        'examples/calibration/least_squares_and_gaussian_calibration',
                                        'examples/calibration/bayesian_calibration',
                                        'examples/numerical_methods/general_methods',
                                        'examples/numerical_methods/optimization',
                                        'examples/numerical_methods/iterative_statistics',
                                        'examples/graphs',]),
     'show_signature': False,

    # directory where function/class granular galleries are stored
    'backreferences_dir'  : 'gen_modules/backreferences',

    # Modules for which function/class level galleries are created.
    'doc_module'          : ('openturns'),

    # The duration of scripts that ran faster than that amount will not be
    # logged nor embedded in the html output
    'min_reported_time': 2,
}

if Version(sphinx_gallery.__version__) >= Version("0.17.0"):
    sphinx_gallery_conf["parallel"] = have_joblib

# TODO: drop jquery in custom search.html
extensions.append('sphinxcontrib.jquery')

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = {'.rst': 'restructuredtext'}

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'OpenTURNS'
copyright = u'2005-2024 Airbus-EDF-IMACS-ONERA-Phimeca'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '@CPACK_PACKAGE_VERSION_MAJOR@.@CPACK_PACKAGE_VERSION_MINOR@'
# The full version, including alpha/beta/rc tags.
release = '@PACKAGE_VERSION@'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'themes', 'sphinxext', '**.ipynb_checkpoints']

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'friendly'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'openturns'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['themes']

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = 'themes/openturns/static/favicon.ico'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_css_files = [
    'css/custom.css',
]

html_js_files = [
    'js/mysearchtools.js',
]


# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'OpenTURNSdoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    'papersize': 'a4paper',
    # The font size ('10pt', '11pt' or '12pt').
    'pointsize': '10pt',
    # Additional stuff for the LaTeX preamble.
    'preamble': r'\usepackage{math_notations}',
}

latex_additional_files = ['math_notations.sty']

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
  ('contents', 'OpenTURNS.tex', u'OpenTURNS Documentation',
   u'Airbus Group - EDF - IMACS - ONERA - Phimeca Engineering', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'openturns', u'OpenTURNS Documentation',
     [u'Airbus Group - EDF - IMACS - ONERA - Phimeca Engineering'], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
  ('index', 'OpenTURNS', u'OpenTURNS Documentation',
   u'Airbus Group - EDF - IMACS - ONERA - Phimeca Engineering', 'OpenTURNS', 'One line description of project.',
   'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

# If true, Sphinx will warn about all references where the target cannot be found.
nitpicky = True