docs: integrate FINAM Book and add API doc

docs/Makefile

+# 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/_static/custom.css

-
-.py.sig {
-    padding-top: 2em;
-    padding-bottom: 1em;
-}

docs/conf.py

-# 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 datetime
-import os
-import sys
-
-from finam import __version__ as ver
-
-# -- Project information -----------------------------------------------------
-
-project = "finam"
-copyright = f"2021 - {datetime.datetime.now().year}, Team LandTECH"
-author = "Team LandTECH"
-
-# The short X.Y version.
-version = ver
-# The full version, including alpha/beta/rc tags.
-release = ver
-
-# -- 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.autosummary",
-    "sphinx.ext.napoleon",  # parameters look better than with numpydoc only
-    "numpydoc",
-    "m2r2",  # markdown includes
-]
-autosummary_generate = True
-# dont show __init__ docstring
-autoclass_content = "class"
-# sort class members
-autodoc_member_order = "groupwise"
-# add all members
-autodoc_default_options = {
-    "members": True,
-    "undoc-members": True,
-    "private-members": "_initialize, _connect, _validate, _update, _finalize, _get_data, _get_info, _source_updated",
-    "inherited-members": True,
-    "show-inheritance": True,
-}
-napoleon_use_admonition_for_notes = True
-numpydoc_show_class_members = True
-numpydoc_class_members_toctree = False
-numpydoc_show_inherited_class_members = True
-
-source_suffix = [".rst", ".md"]
-master_doc = "contents"
-
-# 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 = []
-
-suppress_warnings = ["ref.ref"]
-
-# -- 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"
-
-# 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 = ["custom.css"]

docs/contents.rst

-Welcome to the finam documentation!
-=============================================
-
-.. toctree::
-   :maxdepth: 4
-   :caption: Contents:
-
-   index
-   modules
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/index.rst

-.. mdinclude:: ../README.md

docs/make.bat

+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+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

docs/source/_static/logo.svg

+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="svg8" width="256" height="256" version="1.1" viewBox="0 0 256 256" xmlns="http://www.w3.org/2000/svg"><script xmlns="" id="__gaOptOutExtension"/>
+  <path id="rect1095-4-9-3-1-6-2-58-1-5-4-0-1" d="m57.854 224 13.772-40h88.375v40z" fill="#ffa600" stop-color="#000000" style="font-variation-settings:normal"/>
+  <path id="rect1095-4-9-8-7-5-7-65-5-7-8-8-1-6-9" d="m91 128 13.875-40h99.125v40z" fill="#ffa600" stop-color="#000000" style="font-variation-settings:normal"/>
+  <g id="g8" fill="#005aa0">
+    <path id="rect1095-8-5-97-1-3-4-5-0-6-5" d="m57.375 40 8 20.281-11.266 27.719h-22.109v136h16.312l63.688-184z" stop-color="#000000" style="font-variation-settings:normal"/>
+    <path id="rect1095-4-9-3-1-6-2-58-1-5-4-39" d="m198.15 40-13.772 40h-88.375v-40z" stop-color="#000000" style="font-variation-settings:normal"/>
+    <path id="rect1095-4-9-8-7-5-7-65-5-7-8-8-1-1" d="m165 136-13.875 40h-99.125v-40z" stop-color="#000000" style="font-variation-settings:normal"/>
+    <path id="rect1095-4-9-3-1-6-2-5-5-97-3-3-3-5" d="m48 40 8 20.281-8 19.719h-24l-8-40z" stop-color="#000000" style="font-variation-settings:normal"/>
+  </g>
+  <path id="rect1095-8-5-97-1-3-7-6-1-0-1" d="m207.69 40-63.688 184h54.625l-8-20.281 11.266-27.719h22.109v-136z" fill="#ffa600" stop-color="#000000" style="font-variation-settings:normal"/>
+  <path id="rect1095-4-9-3-1-6-2-5-5-9-7-6-2-7-8" d="m208 224-8-20.281 8-19.719h24l8 40z" fill="#ffa600" stop-color="#000000" style="font-variation-settings:normal"/>
+</svg>
\ No newline at end of file

docs/source/_static/logo_large.svg

+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="svg8" width="91" height="25" version="1.1" viewBox="0 0 91 25" xmlns="http://www.w3.org/2000/svg">
+  <path id="rect1095-4-9-3-1-6-2-58-1-5-4-0-1" d="m6.2317 24 1.7214-5h11.047v5z" fill="#ffa600" stop-color="#000000" style="font-variation-settings:normal"/>
+  <path id="rect1095-4-9-8-7-5-7-65-5-7-8-8-1-6-9" d="m10.375 12 1.7344-5h12.391v5z" fill="#ffa600" stop-color="#000000" style="font-variation-settings:normal"/>
+  <g fill="#005aa0">
+    <path id="rect1095-8-5-97-1-3-4-5-0-6-5" d="m 6.1719,1 1,2.5352 L 5.7637,7 H 3 V 24 H 5.0391 L 13,1 Z" stop-color="#000000" style="font-variation-settings:normal"/>
+    <path id="rect1095-4-9-3-1-6-2-58-1-5-4-39" d="m23.768 1-1.7214 5h-11.047v-5z" stop-color="#000000" style="font-variation-settings:normal"/>
+    <path id="rect1095-4-9-8-7-5-7-65-5-7-8-8-1-1" d="m19.625 13-1.7344 5h-12.391v-5z" stop-color="#000000" style="font-variation-settings:normal"/>
+    <path id="rect1095-4-9-3-1-6-2-5-5-97-3-3-3-5" d="M 5,1 6,3.5351 5,6 H 2 L 1,1 Z" stop-color="#000000" style="font-variation-settings:normal"/>
+  </g>
+  <path id="rect1095-8-5-97-1-3-7-6-1-0-1" d="m24.961 1-7.9609 23h6.8281l-1-2.5352 1.4082-3.4648h2.7637v-17z" fill="#ffa600" stop-color="#000000" style="font-variation-settings:normal"/>
+  <path id="rect1095-4-9-3-1-6-2-5-5-9-7-6-2-7-8" d="m25 24-1-2.5351 1-2.4649h3l1 5z" fill="#ffa600" stop-color="#000000" style="font-variation-settings:normal"/>
+  <text id="text987" x="29.55798" y="15" fill="#005aa0" font-family="Arial" font-size="19.558px" font-weight="bold" letter-spacing="0px" stop-color="#000000" stroke-linecap="round" stroke-linejoin="bevel" stroke-width="0" word-spacing="0px" style="font-variant-caps:normal;font-variant-east-asian:normal;font-variant-ligatures:normal;font-variant-numeric:normal;font-variation-settings:normal;line-height:1.25" xml:space="preserve"><tspan id="tspan985" x="29.55798" y="15" fill="#005aa0" font-family="Arial" font-size="19.558px" font-weight="bold" stop-color="#000000" stroke-linecap="round" stroke-linejoin="bevel" stroke-width="0" style="font-variant-caps:normal;font-variant-east-asian:normal;font-variant-ligatures:normal;font-variant-numeric:normal;font-variation-settings:normal">FINAM</tspan></text>
+  <text id="text991" transform="scale(1.0214 .97905)" x="29.898653" y="24.518534" fill="#ffa600" font-family="Arial" font-size="7.1692px" letter-spacing="0px" stop-color="#000000" stroke-linecap="round" stroke-linejoin="bevel" stroke-width="0" word-spacing="0px" style="font-variation-settings:normal;line-height:1.25" xml:space="preserve"><tspan id="tspan989" x="29.898653" y="24.518534" fill="#ffa600" font-family="Arial" font-size="7.1692px" font-weight="bold" stop-color="#000000" stroke-linecap="round" stroke-linejoin="bevel" stroke-width="0">IS NOT A MODEL</tspan></text>
+</svg>

docs/source/_templates/autosummary/class.rst

+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage

docs/source/api/adapters.rst

+finam.adapters
+==============
+
+.. automodule:: finam.adapters
+
+.. raw:: latex
+
+    \clearpage

docs/source/api/data.rst

+finam.data
+==========
+
+.. automodule:: finam.data
+
+.. raw:: latex
+
+    \clearpage

docs/source/api/generated/finam.adapters.Callback.rst

+finam.adapters.Callback
+=======================
+
+.. currentmodule:: finam.adapters
+
+.. autoclass:: Callback
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
\ No newline at end of file

docs/source/api/generated/finam.adapters.CallbackProbe.rst

+finam.adapters.CallbackProbe
+============================
+
+.. currentmodule:: finam.adapters
+
+.. autoclass:: CallbackProbe
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
\ No newline at end of file

docs/source/api/generated/finam.adapters.GridToValue.rst

+finam.adapters.GridToValue
+==========================
+
+.. currentmodule:: finam.adapters
+
+.. autoclass:: GridToValue
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
\ No newline at end of file

docs/source/api/generated/finam.adapters.Linear.rst

+finam.adapters.Linear
+=====================
+
+.. currentmodule:: finam.adapters
+
+.. autoclass:: Linear
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
\ No newline at end of file

docs/source/api/generated/finam.adapters.LinearIntegration.rst

+finam.adapters.LinearIntegration
+================================
+
+.. currentmodule:: finam.adapters
+
+.. autoclass:: LinearIntegration
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
\ No newline at end of file

docs/source/api/generated/finam.adapters.LinearInterpolation.rst

+finam.adapters.LinearInterpolation
+==================================
+
+.. currentmodule:: finam.adapters
+
+.. autoclass:: LinearInterpolation
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
\ No newline at end of file

docs/source/api/generated/finam.adapters.Nearest.rst

+finam.adapters.Nearest
+======================
+
+.. currentmodule:: finam.adapters
+
+.. autoclass:: Nearest
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
\ No newline at end of file

docs/source/api/generated/finam.adapters.NextValue.rst

+finam.adapters.NextValue
+========================
+
+.. currentmodule:: finam.adapters
+
+.. autoclass:: NextValue
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
\ No newline at end of file

docs/source/api/generated/finam.adapters.PreviousValue.rst

+finam.adapters.PreviousValue
+============================
+
+.. currentmodule:: finam.adapters
+
+.. autoclass:: PreviousValue
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage
\ No newline at end of file