# -*- 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
from pathlib import Path
sys.path.insert(0, os.path.abspath('.'))


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

project = u'Contiki-NG'
copyright = u'2018-2022, Contiki-NG maintainers and contributors'
author = u'Contiki-NG maintainers and contributors'

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


# -- 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 = [
    'api-doc',
    'myst_parser',
    'external_content'
]

# MyST configuration
myst_enable_extensions = [
    "linkify",
]

myst_heading_anchors = 3

# api-doc configuration
api_doc_doxygen_src_dir = '../doxygen'
api_doc_doxygen_out_dir = 'html'
api_doc_doxygen_suppress_out = True
api_doc_doxygen_build = True

# external_content configuration

CONTIKI_BASE = Path(__file__).resolve().parents[2]

external_content_contents = [
    (CONTIKI_BASE, "doc"),
    (CONTIKI_BASE, "examples/**/*.rst"),
    (CONTIKI_BASE, "examples/**/*.md"),
    (CONTIKI_BASE, "examples/**/*.png"),
]

external_content_keep = [
    "*",
    "**/*"
]

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

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

# 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 = [u'_build', 'Thumbs.db', '.DS_Store']

# 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 = {
    'titles_only': False,
    'collapse_navigation': False,
    'navigation_depth': 6
}

html_context = {
  "display_github": True, 
  "github_user": "contiki-ng",
  "github_repo": "contiki-ng",
  "github_version": "develop",
  "conf_py_path": "/"
}

# 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']

# 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 = "contiki_logo.png"

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

# Output file base name for HTML help builder.
htmlhelp_basename = 'Contiki-NGdoc'
