69 lines
1.8 KiB
Python
69 lines
1.8 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
|
|
import os
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
# -- 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.
|
|
#
|
|
sys.path.insert(0, os.path.abspath('../'))
|
|
here = Path(__file__).parent.resolve()
|
|
|
|
# -- Project information
|
|
|
|
project = 'Oracle Instant Client'
|
|
copyright = '2023, Cited Inc.'
|
|
author = 'Cited'
|
|
|
|
release = '0.1'
|
|
version = '0.1.0'
|
|
|
|
|
|
# -- 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 = [
|
|
# 'myst_parser',
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.autosectionlabel',
|
|
'sphinx.ext.autosummary',
|
|
'sphinx.ext.doctest',
|
|
'sphinx.ext.duration',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.viewcode',
|
|
]
|
|
autosectionlabel_prefix_document = True
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = ['.rst', '.md']
|
|
|
|
intersphinx_mapping = {
|
|
'python': ('https://docs.python.org/3/', None),
|
|
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
|
|
}
|
|
intersphinx_disabled_domains = ['std']
|
|
suppress_warnings = [
|
|
# throws an error due to not found reference targets to files not in docs/
|
|
'ref.myst',
|
|
# throws an error due to multiple "Added" labels in "changelog.md"
|
|
'autosectionlabel.*'
|
|
]
|
|
|
|
templates_path = ['_templates']
|
|
|
|
# -- 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'
|
|
|
|
# -- Options for EPUB output
|
|
epub_show_urls = 'footnote'
|