conf.py

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

currpath = os.path.dirname(__file__)
sys.path.insert(0, os.path.abspath('./'))
from helper import *

########################################################################################
# -- Download rst file -----------------------------------------------------
download_file('https://erdogant.github.io/docs/rst/sponsor.rst', "sponsor.rst")
download_file('https://erdogant.github.io/docs/rst/add_carbon.add', "add_carbon.add")
download_file('https://erdogant.github.io/docs/rst/add_top.add', "add_top.add")
download_file('https://erdogant.github.io/docs/rst/add_bottom.add', "add_bottom.add")
########################################################################################
add_includes_to_rst_files(top=False, bottom=True)
########################################################################################
# Import PDF from directory in rst files
# embed_in_rst(currpath, 'pdf', '.pdf', "Additional Information", 'Additional_Information.rst')
########################################################################################
# Import notebooks in HTML format
# convert_ipynb_to_html(currpath, 'notebooks', '.ipynb')
# embed_in_rst(currpath, 'notebooks', '.html', "Notebook", 'notebook.rst')
########################################################################################

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

project = 'clusteval'
copyright = '2022, Erdogan Taskesen'
author = 'Erdogan Taskesen'

# The master toctree document.
master_doc = 'index'

# The full version, including alpha/beta/rc tags
release = 'clusteval'
version = str(clusteval.__version__)

# -- 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.napoleon",
	"sphinx.ext.intersphinx",
	"sphinx.ext.autosectionlabel",
	"rst2pdf.pdfbuilder",
#    'sphinx.ext.duration',
#    'sphinx.ext.doctest',
#    'sphinx.ext.autosummary',
]

#intersphinx_mapping = {
#    'python': ('https://docs.python.org/3/', None),
#    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
#}
#
#intersphinx_disabled_domains = ['std']

napoleon_google_docstring = False
napoleon_numpy_docstring = True

# autodoc_mock_imports = ['cv2','keras']


pdf_documents = [('index', u'clusteval', u'clusteval', u'Erdogan Taskesen'),]

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


# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# -- 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'
# html_theme = 'default'
html_theme = 'sphinx_rtd_theme'


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

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = ['css/custom.css',]

# A list of files that should not be packed into the epub file
epub_exclude_files = ['search.html']

# -- Options for EPUB output
epub_show_urls = 'footnote'

# html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'carbon_ads.html', 'sourcelink.html', 'searchbox.html'] }