add reference to etl-entities

MobileTeleSystems · Nov 17, 2023 · ff10be9 · ff10be9
1 parent e8531b8
commit ff10be9
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -57,6 +57,7 @@
     "sphinxcontrib.autodoc_pydantic",
     "sphinxcontrib.towncrier",  # provides `towncrier-draft-entries` directive
     "sphinxcontrib.plantuml",
+    "sphinx.ext.extlinks",
 ]
 numpydoc_show_class_members = True
 autodoc_pydantic_model_show_config = False
@@ -119,6 +120,12 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 
+# Create an alias for etl-entities lib in onetl documentation
+extlinks = {
+    "etl-entities": ("https://etl-entities.readthedocs.io/en/latest/%s", None),
+}
+
+
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 

diff --git a/docs/hwm_store/index.rst b/docs/hwm_store/index.rst
@@ -1,10 +1,30 @@
 .. _hwm-store:
 
-YAML HWM Store
+HWM
 =========
 
+Since ``onetl>=0.10.0`` version, the HWM Store and HWM classes have been moved to a separate library :etl-entities:`etl-entities <>`.
+
+|
+| **HWM Store**
+- :etl-entities:`Base HWM Store <hwm_store/base_hwm_store.html>` This class facilitates the creation of custom hwm stores.
+- :etl-entities:`Memory HWM Store <hwm_store/memory_hwm_store.html>` This class serving as an example for storing hwms in memory.
+|
+| **HWM**
+Moreover, HWM classes that operate with HWM stores have also been relocated to the :etl-entities:`etl-entities <>` library. These include:
+
+- :etl-entities:`Column Int HWM <hwm/column/int_hwm.html>`
+- :etl-entities:`Column Date HWM <hwm/column/date_hwm.html>`
+- :etl-entities:`Column DateTime HWM <hwm/column/datetime_hwm.html>`
+- :etl-entities:`File List HWM <hwm/file/file_list_hwm.html>`
+
+For detailed insights into the various HWM classes available, refer to the documentation on:
+
+- :etl-entities:`What is HWM </hwm/column/index.html#what-is-hwm>`
+
+Below is the **default HWM store** in onETL - YAML HWM Store:
+
 .. toctree::
     :maxdepth: 2
-    :caption: HWM store
 
     yaml_hwm_store
diff --git a/docs/hwm_store/yaml_hwm_store.rst b/docs/hwm_store/yaml_hwm_store.rst
@@ -1,6 +1,6 @@
 .. _yaml-hwm-store:
 
-YAML HWM Store (local, default)
+YAML HWM Store
 =================================================================
 
 .. currentmodule:: onetl.hwm.store.yaml_hwm_store

diff --git a/docs/index.rst b/docs/index.rst
@@ -48,7 +48,7 @@
 
 .. toctree::
     :maxdepth: 2
-    :caption: HWM and incremental reads
+    :caption: Read strategies and HWM
     :hidden:
 
     strategy/index

diff --git a/onetl/hwm/store/yaml_hwm_store.py b/onetl/hwm/store/yaml_hwm_store.py
@@ -67,7 +67,7 @@ class MyClass(BaseHWMStore):
 @register_hwm_store_class("yaml")
 @support_hooks
 class YAMLHWMStore(BaseHWMStore, FrozenModel):
-    r"""YAML local store for HWM values. Used as default HWM store. |support_hooks|
+    r"""YAML **local store** for HWM values. Used as default HWM store. |support_hooks|
 
     Parameters
     ----------