"""
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/latest/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 linecache
import os
import re
import sys

sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.dirname(__file__))

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

project = 'yaenv'
copyright = '2019-2021, ObserverOfTime, BSD 3-Clause License'
author = 'ObserverOfTime'

# The full version, including alpha/beta/rc tags
release = re.search('"(.+)"', linecache.getline('pyproject.toml', 3)).group(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',
    'sphinx.ext.extlinks',
    'sphinx.ext.napoleon',
    'sphinx.ext.viewcode',
]

# Napoleon settings
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = True
napoleon_use_param = True
napoleon_use_rtype = False

# Autodoc settings
autodoc_member_order = 'bysource'

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

source_suffix = '.rst'

master_doc = 'index'

needs_sphinx = '4.1'

extlinks = {
    'dj': ('https://docs.djangoproject.com/en/3.2/ref/settings/#%s', ''),
    'os': ('https://docs.python.org/3.10/library/os.html#os.%s', 'os.')
}

# -- 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'
html_theme_path = [
    __import__(html_theme).get_html_theme_path()
]
html_theme_options = {
    'display_version': True,
    'collapse_navigation': True,
}

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

"""
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/latest/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 linecache
import os
import re
import sys

sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.dirname(__file__))

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

project = 'yaenv'
copyright = '2019-2021, ObserverOfTime, BSD 3-Clause License'
author = 'ObserverOfTime'

# The full version, including alpha/beta/rc tags
release = re.search('"(.+)"', linecache.getline('pyproject.toml', 3)).group(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',
    'sphinx.ext.extlinks',
    'sphinx.ext.napoleon',
    'sphinx.ext.viewcode',
]

# Napoleon settings
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = True
napoleon_use_param = True
napoleon_use_rtype = False

# Autodoc settings
autodoc_member_order = 'bysource'

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

source_suffix = '.rst'

master_doc = 'index'

needs_sphinx = '4.1'

extlinks = {
    'dj': ('https://docs.djangoproject.com/en/3.2/ref/settings/#%s', ''),
    'os': ('https://docs.python.org/3.10/library/os.html#os.%s', 'os.')
}

# -- 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'
html_theme_path = [
    __import__(html_theme).get_html_theme_path()
]
html_theme_options = {
    'display_version': True,
    'collapse_navigation': True,
}

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

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/latest/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. # -- Project information ----------------------------------------------------- # The full version, including alpha/beta/rc tags # -- 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. # Napoleon settings # Autodoc settings # Add any paths that contain templates here, relative to this directory. # 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. #%s', ''), #os.%s', 'os.') # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. # See the documentation for a list of builtin themes. # 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".