# 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:
# 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('.'))

import inspect

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

project = "pymgclient"
copyright = "2022, Memgraph Ltd."
author = "Memgraph Ltd."

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


# -- 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"]
autodoc_docstring_signature = True

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

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


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

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


def setup(app):
    # Type signature from C docstring is stripped and stored in
    # __text_signature__ attribute, so __doc__ attribute doesn't contain it.
    # Because of this, `autodoc_docstring_signature` doesn't work so we have to
    # do it manually.
    def process_signature(app, what, name, obj, options, signature, return_annotation):
        if signature:
            return (signature, return_annotation)

        try:
            sig = inspect.signature(obj)
            return (str(sig), return_annotation)
        except BaseException:
            return (None, None)

    app.connect("autodoc-process-signature", process_signature)
