# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- 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('../..'))
from kibot import __version__, __copyright__


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

project = 'KiBot'
copyright = __copyright__[10:]
author = 'Salvador E. Tropea'

# The full version, including alpha/beta/rc tags
release = __version__


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

# 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.ext.autodoc',
]

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

# 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 = ['dependencies.rst', 'configuration/sup_outputs.rst', 'configuration/sup_preflights.rst',
                    'configuration/sup_filters.rst', 'configuration/sup_variants.rst', 'configuration/sup_globals.rst']


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

# 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_logo = '../images/kibot_370x200.png'
github_url = 'https://github.com/INTI-CMNB/KiBot'
html_show_sourcelink = False

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

import subprocess
branch = subprocess.check_output(['git', 'rev-parse', '--abbrev-ref', 'HEAD']).decode().strip()
if branch == 'HEAD':
    ver = os.environ.get('READTHEDOCS_VERSION', 'latest')
    branch = 'dev' if ver == 'latest' else 'master'

if branch != "master":
    doc_id = ("**This is the documentation for the current development KiBot, not yet released. "
              "To know what changed see the**  `changelog <CHANGELOG.md>`__")
else:
    doc_id = (f"**This is the documentation for KiBot v{release} for the current development read** "
              "`here <https://github.com/INTI-CMNB/KiBot/tree/dev>`__")

rst_prolog = f"""
.. |br| raw:: html

   <br/>
.. |branch| replace:: {branch} {release}
.. |doc_id| replace:: {doc_id}
.. |Python application| image:: https://img.shields.io/github/actions/workflow/status/INTI-CMNB/KiBot/pythonapp.yml?branch={branch}&style=plastic&logo=github
   :target: https://github.com/INTI-CMNB/KiBot/actions
"""  # noqa: E501