<reponame>altaris/seat-navy-issue
# pylint: skip-file

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


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

project = 'SeAT Navy Issue'
copyright = '2020, Cédric HT'
author = '<NAME>'

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

html_logo = 'logo.256.png'
html_favicon = 'logo.32.png'


# -- 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-jsonschema',
    'sphinx.ext.autodoc',
    'sphinx.ext.githubpages',
    'sphinx.ext.napoleon',
    'sphinx.ext.todo',
    'sphinx.ext.viewcode',
#   'sphinxcontrib.openapi',
]

# 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.
# Reference: https://sphinx-themes.org/
html_theme = 'classic'

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


# -- Autodoc settings --------------------------------------------------------

# Reference: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration

exclude_members = [
    '__objects',
    '__weakref__',
    '_abc_impl',
    '_cached_reference_fields',
    '_class_name',
    '_collection',
    '_db_field_map',
    '_fields_ordered',
    '_fields',
    '_generate_next_value_',
    '_instance',
    '_is_base_cls',
    '_is_document',
    '_member_map_',
    '_member_names_',
    '_member_type_',
    '_meta',
    '_reverse_db_field_map',
    '_subclasses',
    '_superclasses',
    '_types',
    '_value2member_map_',
    'DoesNotExist',
    'id',
    'MultipleObjectsReturned',
    'objects',
]

autodoc_default_options = {
    'exclude-members': ', '.join(exclude_members),
    'member-order': 'alphabetical',
    'members': True,
    'private-members': False,
    'show-inheritance': False,
    'undoc-members': True,
}
autodoc_inherit_docstrings = False
autodoc_typehints = 'signature'



# -- Napoleon settings -------------------------------------------------------

# Reference:
# https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#configuration

napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = True
napoleon_include_special_with_doc = True


# -- Todo settings ------------------------------------------------------------

# Reference:
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html

todo_include_todos = True
