# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# 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.

import os
import sys
# sys.path.insert(0, os.path.abspath('.'))
docs_path = os.path.normpath(os.path.abspath('.'))

# python source code path
pytoulbar2_code_path = os.path.normpath(os.path.join(docs_path, "..", "..",
                                                                "pytoulbar2"))
sys.path.insert(0, pytoulbar2_code_path)

# -- Project information -----------------------------------------------------

project = 'toulbar2'
copyright = '2022, INRAE'
author = 'INRAE'

# The short X.Y version
version = '1.0'
# The full version, including alpha/beta/rc tags
release = '1.0.0'


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

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

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx_rtd_theme',
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.viewcode',
    #'sphinx.ext.imgmath',
    #'sphinx.ext.mathjax',
    'sphinx.ext.githubpages', # => .nojekyll file
    'sphinx.ext.graphviz',
    'breathe',
    'myst_parser',
    'sphinx.ext.autosectionlabel',
]

# Breathe
breathe_default_project = "toulbar2cpp"
breathe_projects = {
    "toulbar2cpp" : os.path.normpath(os.path.join(docs_path, "..", "..",
                                                  "build", "xml")),
}
#breathe_implementation_filename_extensions = ['.c', '.cc', '.cpp']

# Prefix document path to section labels, to use:
# `path/to/file:heading` instead of just `heading`
autosectionlabel_prefix_document = True

# Add any paths that contain templates here, relative to this directory.
templates_path = [os.path.join(docs_path,'_templates')]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
source_suffix = ['.rst', '.md']

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['Thumbs.db', '.DS_Store',
                    #'_build', _pyvenv', 'README.md',
                   ]

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

# -- 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 = 'sphinx_rtd_theme'

# 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 = {}
html_theme_options = {
    #'logo_only': False,
    #'display_version': True,
    #'prev_next_buttons_location': 'bottom',
    #'style_external_links': False,
    #'vcs_pageview_mode': '',
    #'style_nav_header_background': 'FireBrick',
    ## Toc options
    #'collapse_navigation': True,
    #'sticky_navigation': True,
    'navigation_depth': 4,
    #'includehidden': True, # False,
    #'titles_only': False
}

# 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 = [os.path.join(docs_path,'_static')]

html_style = 'css/toulbar2.css'

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}

#html_logo = 

# -- Options for HTMLHelp output ---------------------------------------------

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


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

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # remove blank pages (between the title page and the TOC, etc.)
    'classoptions': ',openany,oneside',
    'babel' : '\\usepackage[english]{babel}',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# 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 = [

    # extracts 

    ('examples/tutorials_pdf', 'tutorials.tex',
     '', # to keep .rst title
     'INRAE', 'manual'),

    ('examples/usecases_pdf', 'usecases.tex',
     '', # to keep .rst title
     'INRAE', 'manual'),

    ('refman', 'refman.tex',
     'toulbar2 Reference Manual',
     'INRAE', 'manual'),

    ('userdoc', 'userdoc.tex',
     'toulbar2 User Guide',
     'INRAE', 'manual'),

    ('formats/wcspformat', 'WCSP_format.tex',
     '', # to keep .rst title
     'INRAE', 'manual'),

    ('formats/cfnformat', 'CFN_format.tex',
     '', # to keep .rst title
     'INRAE', 'manual'),

    # api ref

    ('ref/ref_cpp', 'cpp_library.tex',
     'C++ Library of toulbar2',
     'INRAE', 'manual'),
    ('ref/ref_python', 'python_library.tex',
     'Python Library of toulbar2',
     'INRAE', 'manual'),

    # main

    ('index_pdf', 'toulbar2.tex',
     'toulbar2 Documentation',
     'INRAE', 'manual'),
]

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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'toulbar2', 'toulbar2 Documentation',
     [author], 1)
]


# -- 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 = [
    (master_doc, 'toulbar2', 'toulbar2 Documentation',
     author, 'toulbar2', 'One line description of project.',
     'Miscellaneous'),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']


# -- Extension configuration -------------------------------------------------
