# 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

import ssh

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

project = 'ssh-python'

copyright = '2022, Panos Kittenis'

author = 'Panos Kittenis'

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

# 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.intersphinx',

'sphinx.ext.todo',

]

# Autodoc settings

autodoc_default_flags = ['members']

# Add any paths that contain templates here, relative to this directory.

# templates_path = ['templates']

# The suffix of source filenames.

source_suffix = '.rst'

# The encoding of source files.

# source_encoding = 'utf-8-sig'

# The master toctree document.

master_doc = 'index'

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

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

# If true, links to the reST sources are added to the pages.

html_show_sourcelink = False

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

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

# The version info for the project you're documenting, acts as replacement for

# |version| and |release|, also used in various other places throughout the

# built documents.

#

# The short X.Y version.

version = ssh.__version__

# The full version, including alpha/beta/rc tags.

release = ssh.__version__

# The name of the Pygments (syntax highlighting) style to use.

pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.

todo_include_todos = True

# 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 = {

'navigation_depth': 2,

'collapse_navigation': False,

'display_version': 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 = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names

# to template names.

#

# This is required for the alabaster theme

# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars

html_sidebars = {

'**': [

'about.html',

'navigation.html',

'relations.html', # needs 'show_related': True theme option to display

'searchbox.html',

]

}

# Output file base name for HTML help builder.

htmlhelp_basename = 'ssh-pythondoc'

intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

autoclass_content = "both"

# A list of files that should not be packed into the epub file.

epub_exclude_files = ['search.html']