docs: init import docs scaffolding

.github/workflows/docs-preview.yml

@@ -0,0 +1,20 @@
+name: Read the Docs Pull Request Preview
+
+on:
+  pull_request_target:
+    types:
+    - opened
+  workflow_dispatch:
+    inputs: { }
+  pull_request:
+
+permissions:
+  pull-requests: write
+
+jobs:
+  pr-preview-links:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: readthedocs/actions/preview@v1
+      with:
+        project-slug: "meltano-edk"

.readthedocs.yml

@@ -0,0 +1,14 @@
+version: 2
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  version: 3.8
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/css/custom.css

@@ -0,0 +1,128 @@
+body {
+  font-family: "IBM Plex Sans", -apple-system, BlinkMacSystemFont, "Segoe UI",
+    Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans",
+    "Helvetica Neue", sans-serif;
+  color: #2c3e50;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+a,
+a:visited {
+  color: #3438bf;
+}
+a:hover {
+  color: #3438bf;
+  text-decoration: underline;
+}
+
+.wy-nav-top {
+  background-color: #3438bf;
+}
+
+.wy-nav-top a {
+  color: white;
+  text-decoration: none !important;
+}
+
+.wy-nav-side {
+  background-color: #3438bf;
+}
+
+.wy-side-nav-search {
+  background-color: #3438bf;
+}
+
+.wy-side-nav-search > a {
+  color: #fcfcfc;
+  text-decoration: none !important;
+  font-size: 24px;
+  font-weight: bold;
+}
+
+.wy-side-nav-search > a img.logo {
+  display: inline-block;
+  height: 2.3rem;
+  padding: 0;
+  vertical-align: text-bottom;
+  position: relative;
+  top: 1px;
+}
+
+.wy-side-nav-search > div.version {
+  color: hsla(0, 0%, 100%, 0.7);
+}
+
+.wy-side-nav-search input[type="text"] {
+  border-color: #3438bf;
+}
+
+.wy-menu-vertical a:hover {
+  background-color: #3438bf;
+}
+
+.wy-menu-vertical a,
+.wy-menu-vertical a:hover,
+.wy-menu-vertical a:visited {
+  color: white;
+}
+
+.wy-menu-vertical li.current > a,
+.wy-menu-vertical li.on a {
+  background-color: white;
+}
+
+.wy-nav-content-wrap,
+.wy-nav-content {
+  background-color: white;
+}
+
+.rst-versions,
+.rst-versions .rst-current-version {
+  background-color: #3438bf;
+}
+
+.rst-versions .rst-current-version {
+  color: #fbbf52;
+}
+
+.rst-versions .rst-other-versions {
+  color: white;
+}
+
+.rst-versions a {
+  color: white;
+  text-decoration: underline;
+}
+
+.rst-versions .rst-other-versions dl {
+  margin: 5px 0;
+}
+
+.rst-versions .rst-other-versions dt {
+  margin-bottom: 3px;
+}
+
+.rst-versions .rst-other-versions dd a {
+  border: 1px solid white;
+  border-radius: 5px;
+  padding: 3px 6px;
+  text-decoration: none;
+}
+
+.rst-versions .rst-other-versions dd a:hover {
+  color: #3438bf;
+  background-color: white;
+}
+
+.rst-content code.literal {
+  color: #62626e;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  font-family: inherit;
+}

docs/_templates/class.rst

@@ -0,0 +1,8 @@
+{{ fullname }}
+{{ "=" * fullname|length }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ name }}
+    :members:
+    :special-members: __init__

docs/_templates/footer.html

@@ -0,0 +1,9 @@
+{% extends '!footer.html' %}
+{% block extrafooter %}
+
+    The SDK is built with love by the <a href="https://meltano.com">Meltano</a> core team and contributors, with
+    contributions from developers across the <a href="https://singer.io">Singer</a> open source community.
+
+    <!-- Docs built using <a href="https://www.sphinx-doc.org">Sphinx</a> and <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    from <a href="https://readthedocs.org">Read the Docs</a>. -->
+{% endblock %}

docs/_templates/layout.html

@@ -0,0 +1,7 @@
+{% extends '!layout.html' %}
+{% block extrahead %}
+  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans&amp;display=swap">
+  <link rel="apple-touch-icon" sizes="180x180" href="{{ pathto('_static/img/melty-apple-touch-icon.png', 1) }}">
+  <link rel="icon" type="image/png" sizes="32x32" href="{{ pathto('_static/img/melty-favicon-32x32.png', 1) }}">
+  <link rel="icon" type="image/png" sizes="16x16" href="{{ pathto('_static/img/melty-favicon-16x16.png', 1) }}">
+{% endblock %}

docs/classes/meltano.edk.extension.DescribeFormat.rst

@@ -0,0 +1,8 @@
+meltano.edk.extension.DescribeFormat
+====================================
+
+.. currentmodule:: meltano.edk.extension
+
+.. autoclass:: DescribeFormat
+    :members:
+    :special-members: __init__

docs/classes/meltano.edk.extension.ExtensionBase.rst

@@ -0,0 +1,8 @@
+meltano.edk.extension.ExtensionBase
+===================================
+
+.. currentmodule:: meltano.edk.extension
+
+.. autoclass:: ExtensionBase
+    :members:
+    :special-members: __init__

docs/classes/meltano.edk.process.Invoker.rst

@@ -0,0 +1,8 @@
+meltano.edk.process.Invoker
+===========================
+
+.. currentmodule:: meltano.edk.process
+
+.. autoclass:: Invoker
+    :members:
+    :special-members: __init__

docs/conf.py

@@ -0,0 +1,65 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, 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 -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Meltano EDK"
+copyright = "2022, Meltano Core Team and Contributors"
+author = "Meltano Core Team and Contributors"
+release = "0.0.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.autosummary",
+    "sphinx_rtd_theme",
+    "sphinx_copybutton",
+    "myst_parser",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# Show typehints in the description, along with parameter descriptions
+autodoc_typehints = "signature"
+autodoc_class_signature = "separated"
+
+# -- 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"
+html_theme_options = {"logo_only": True, "analytics_id": "G-NYV2096KBJ"}
+
+html_logo = "_static/img/logo.svg"
+
+# 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_css_files = [
+    "css/custom.css",
+]
+
+# TODO: set this back to 3 after MyST-Parser 0.18.0 is released
+myst_heading_anchors = 4

docs/index.rst

@@ -0,0 +1,29 @@
+.. Meltano EDK documentation master file, created by
+   sphinx-quickstart on Tue Oct  4 14:30:23 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Meltano EDK's documentation!
+=======================================
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+Reference
+---------
+
+.. toctree::
+   :maxdepth: 2
+
+   reference
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd