add sphinx

Signed-off-by: Philip May <philip@may.la>

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     = source
+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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%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
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/README.md

@@ -0,0 +1 @@
+../../README.md

docs/source/_static/css/custom.css

@@ -0,0 +1,20 @@
+/*
+.wy-nav-top: top box in mobile view
+.wy-side-nav-search: top left box in nav bar
+.wy-side-nav-search > a:hover: no hover highlight
+*/
+.wy-nav-top,
+.wy-side-nav-search,
+.wy-side-nav-search > a:hover {
+    background-color: #2980b9;
+}
+
+/* broader content area */
+.wy-nav-content {
+    max-width: 1000px;
+}
+
+/* top left project name -> bigger */
+.wy-side-nav-search > a.icon.icon-home {
+    font-size: 160%;
+}

docs/source/api-ref.md

@@ -0,0 +1,11 @@
+# API Reference
+
+```{toctree}
+---
+glob:
+titlesonly:
+maxdepth: 2
+---
+
+api-ref/*
+```

docs/source/api-ref/client.md

@@ -0,0 +1,5 @@
+# client
+
+```{eval-rst}
+.. autoclass:: opensearchpy.OpenSearch
+```

docs/source/api-ref/connection.md

@@ -0,0 +1,13 @@
+# connection 
+
+```{eval-rst}
+.. autoclass:: opensearchpy.Connection
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.RequestsHttpConnection
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.Urllib3HttpConnection
+```

docs/source/api-ref/connection_pool.md

@@ -0,0 +1,13 @@
+# connection_pool
+
+```{eval-rst}
+.. autoclass:: opensearchpy.ConnectionPool
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.ConnectionSelector
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.RoundRobinSelector
+```

docs/source/api-ref/exceptions.md

@@ -0,0 +1,57 @@
+# exceptions
+
+```{eval-rst}
+.. autoclass:: opensearchpy.AuthenticationException
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.AuthorizationException
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.ConflictError
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.ConnectionError
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.ConnectionTimeout
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.ImproperlyConfigured
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.NotFoundError
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.OpenSearchDeprecationWarning
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.OpenSearchException
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.OpenSearchWarning
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.RequestError
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.SerializationError
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.SSLError
+```
+
+```{eval-rst}
+.. autoclass:: opensearchpy.TransportError
+```

docs/source/api-ref/serializer.md

@@ -0,0 +1,5 @@
+# serializer
+
+```{eval-rst}
+.. autoclass:: opensearchpy.JSONSerializer
+```

docs/source/api-ref/transport.md

@@ -0,0 +1,5 @@
+# transport
+
+```{eval-rst}
+.. autoclass:: opensearchpy.Transport
+```

docs/source/conf.py

@@ -0,0 +1,111 @@
+# 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 = 'OpenSearch Python Client'
+copyright = 'OpenSearch Project Contributors'
+author = 'OpenSearch Project Contributors'
+
+
+# -- 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_rtd_theme",
+    "sphinx.ext.viewcode",
+    "myst_parser",  # https://myst-parser.readthedocs.io/
+    "sphinx.ext.intersphinx",
+    "sphinx_copybutton",  # https://github.com/executablebooks/sphinx-copybutton
+    "sphinx.ext.todo",  # https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
+]
+
+# 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 = []
+
+
+# -- 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']
+
+# -- additional settings -------------------------------------------------
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}
+
+html_logo = "imgs/OpenSearch.svg"
+
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = [
+    "css/custom.css",
+]
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+# add github link
+html_context = {
+    "display_github": True,
+    "github_user": "opensearch-project",
+    "github_repo": "opensearch-py",
+    "github_version": "main/docs/source/",
+}
+
+# -- autodoc config -------------------------------------------------
+# This value controls how to represent typehints.
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints
+autodoc_typehints = "description"
+
+# This value selects what content will be inserted into the main body of an autoclass directive.
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content
+autoclass_content = "both"
+
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-add_module_names
+# add_module_names = False
+
+# The default options for autodoc directives.
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options
+autodoc_default_options = {
+    # If set, autodoc will generate document for the members of the target module, class or exception.  # noqa: E501
+    # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-members
+    "members": True,
+    "show-inheritance": True,
+    # If set, autodoc will also generate document for the special members (that is, those named like __special__).  # noqa: E501
+    # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-special-members
+    "special-members": None,
+    # If set, autodoc will also generate document for the private members (that is, those named like _private or __private).  # noqa: E501
+    # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-private-members
+    "private-members": None,
+    "exclude-members": "__weakref__, __init__",
+}

docs/source/genindex.md

@@ -0,0 +1 @@
+# Index

docs/source/imgs/OpenSearch.svg

@@ -0,0 +1 @@
+../../../OpenSearch.svg

docs/source/index.md

@@ -0,0 +1,19 @@
+# OpenSearch Python Client Documentation
+
+## Table of Contents
+```{toctree}
+---
+maxdepth: 1
+---
+
+api-ref
+genindex
+License <https://github.com/opensearch-project/opensearch-py/blob/main/LICENSE.txt>
+Contributing <https://github.com/opensearch-project/opensearch-py/blob/main/CONTRIBUTING.md>
+Code of Conduct <https://github.com/opensearch-project/opensearch-py/blob/main/CODE_OF_CONDUCT.md>
+Developer Guide <https://github.com/opensearch-project/opensearch-py/blob/main/DEVELOPER_GUIDE.md>
+GitHub Repository <https://github.com/opensearch-project/opensearch-py>
+```
+
+```{include} README.md
+```