5eb2af6c08
* CDK Autogenerated reference docs: base version * Update docs config. Add .readthedocs.yaml file. Update build html files. * Update .gitignore. Remove sphinx build files. * Add newline at the end of .gitignore * Update setup.py requirements. Update .readthedocs.yaml config. * Update rst files. Add Makefile rst config. * Update CDK docstring format. Change rst layout. Update sphinx config. * Add Sphinx docs. Update index.rst. Update abstract_source.py docstrings. * Override master_doc and package templates. Add docs schema enerator script. Update sphinx docs. * Add `Publishing to Read the Docs` section to sphinx-docs.md". Replace sphinx-docs.md to `airbyte-cdk` module. * Update sphinx-docs.md section name * Bump airbyte-cdk version. Update CHANGELOG.md. Co-authored-by: ykurochkin <y.kurochkin@zazmic.com> Co-authored-by: Vadym Hevlich <vege1wgw@gmail.com>
64 lines
2.1 KiB
Python
64 lines
2.1 KiB
Python
#
|
|
# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
|
|
#
|
|
|
|
# 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("../.."))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "Airbyte Connector Development Kit"
|
|
copyright = "2021, Airbyte"
|
|
author = "Airbyte"
|
|
|
|
|
|
# -- 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"] # API docs
|
|
|
|
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
|
|
|
|
# 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"]
|
|
|
|
|
|
# -- 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"
|
|
|
|
# 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']
|
|
html_logo = "../_static/img/airbyte_new_logo.svg"
|
|
html_theme_options = {
|
|
"logo_only": True,
|
|
"display_version": False,
|
|
}
|