"""

Copyright 2023 Cognitive Scale, Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

"""

# -*- coding: utf-8 -*-

#

# CORTEX Python SDK documentation build configuration file, created by

# sphinx-quickstart on Thu Jun 8 15:19:41 2017.

#

# This file is execfile()d with the current directory set to its

# containing dir.

#

# Note that not all possible configuration values are present in this

# autogenerated file.

#

# All configuration values have a default; values that are commented out

# serve to show the default.

# 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

# Include cortex/ in the system path

sys.path.insert(0, os.path.abspath(".."))

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

# If your documentation needs a minimal Sphinx version, state it here.

#

# needs_sphinx = '1.0'

# 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', 'sphinxcontrib.restbuilder']

extensions = [

"sphinx.ext.autodoc",

"sphinx_rtd_theme",

"sphinx_multiversion",

"sphinx.ext.githubpages",

]

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

# templates_path = ['_templates']

# The suffix(es) of source filenames.

# You can specify multiple suffix as a list of string:

#

# source_suffix = ['.rst', '.md']

source_suffix = ".rst"

# The master toctree document.

master_doc = "index"

# General information about the project.

project = "Cortex Python Library"

copyright = "2023, CognitiveScale"

author = "CognitiveScale"

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

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

release = version

# 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 patterns also effect to html_static_path and html_extra_path

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

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

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

# for classic theme options see https://www.sphinx-doc.org/en/master/usage/theming.html#builtin-themes

html_theme_options = {

"display_version": False,

"prev_next_buttons_location": "bottom",

# Toc options

"collapse_navigation": False,

"sticky_navigation": True,

"navigation_depth": 4,

"includehidden": True,

"titles_only": False,

}

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

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

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.

htmlhelp_basename = "CORTEXPythonLibraryDoc"

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {

# The paper size ('letterpaper' or 'a4paper').

#

# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').

#

# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.

#

# 'preamble': '',

# Latex figure (float) alignment

#

# 'figure_align': 'htbp',

}

# Grouping the document tree into LaTeX files. List of tuples

# (source start file, target name, title,

# author, documentclass [howto, manual, or own class]).

latex_documents = [

(

master_doc,

"CORTEXPythonSDK.tex",

"Cortex Python Library Documentation",

"CognitiveScale",

"manual",

),

]

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples

# (source start file, name, description, authors, manual section).

man_pages = [

(

master_doc,

"cortexpythonclient",

"Cortex Python Library Documentation",

[author],

1,

)

]

# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples

# (source start file, target name, title, author,

# dir menu entry, description, category)

texinfo_documents = [

(

master_doc,

"CORTEXPythonSDK",

"Cortex Python Library Documentation",

author,

"CORTEXPythonSDK",

"Cortex Python Library Documentation",

"Miscellaneous",

),

]

# Copied from https://stackoverflow.com/questions/49331914/enable-versions-in-sidebar-in-sphinx-read-the-docs-theme

############################

# SETUP THE RTD LOWER-LEFT #

############################

try:

html_context

except NameError:

html_context = dict()

html_context["display_lower_left"] = True

templates_path = ["_templates"]

# Regex for branches to build docs

smv_branch_whitelist = "^(main|staging|develop)$"

# tag format vX.Y.Z

smv_tag_whitelist = r"^release/\d+\.\d+\.\d+$"

# all tags are considered released

smv_released_pattern = r"^refs/tags/.*$"

html_favicon = "_static/favicon.png"

if "MULTI_VERSION" in os.environ:

# skip version template if metadata isn't available

MULTI_VERSION = os.environ["MULTI_VERSION"]

html_context["MULTI_VERSION"] = MULTI_VERSION