Add workflow to check if doc builds

Author: vhaldemar

.github/workflows/tests.yaml

@@ -7,6 +7,7 @@ on:
 
 jobs:
   all-tests:
+    name: Python tests
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -28,7 +29,9 @@ jobs:
 
       - name: "Tests"
         run: tox -e py${{ matrix.python-version }}${{ matrix.env}} -- -vv
+
   pre-commit-ci-lite:
+    name: pre-commit checks
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
@@ -38,3 +41,15 @@ jobs:
     - uses: pre-commit/action@v3.0.1
     - uses: pre-commit-ci/lite-action@v1.1.0
       if: always()
+
+  build-docs:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: 3.13
+        cache: 'pip'
+    - run: pip install tox tox-gh-actions
+    - run: tox -e docs -vv

docs/base/bases.rst

@@ -2,3 +2,43 @@ Base classes
 ============
 
 .. autoclass:: yandex_cloud_ml_sdk._sdk.BaseSDK
+
+.. autoclass:: yandex_cloud_ml_sdk._types.domain.BaseDomain
+
+.. autoclass:: yandex_cloud_ml_sdk._types.model.BaseModel
+
+.. autoclass:: yandex_cloud_ml_sdk._types.model_config.BaseModelConfig
+
+.. autoclass:: yandex_cloud_ml_sdk._auth.BaseAuth
+
+.. autoclass:: yandex_cloud_ml_sdk._tools.domain.BaseTools
+
+.. autoclass:: yandex_cloud_ml_sdk._tools.tool.BaseTool
+
+.. autoclass:: yandex_cloud_ml_sdk._models.BaseModels
+
+.. autoclass:: yandex_cloud_ml_sdk._threads.domain.BaseThreads
+
+.. autoclass:: yandex_cloud_ml_sdk._threads.thread.BaseThread
+
+.. autoclass:: yandex_cloud_ml_sdk._files.domain.BaseFiles
+
+.. autoclass:: yandex_cloud_ml_sdk._files.file.BaseFile
+
+.. autoclass:: yandex_cloud_ml_sdk._assistants.domain.BaseAssistants
+
+.. autoclass:: yandex_cloud_ml_sdk._assistants.assistant.BaseAssistant
+
+.. autoclass:: yandex_cloud_ml_sdk._runs.domain.BaseRuns
+
+.. autoclass:: yandex_cloud_ml_sdk._runs.run.BaseRun
+
+.. autoclass:: yandex_cloud_ml_sdk._search_indexes.domain.BaseSearchIndexes
+
+.. autoclass:: yandex_cloud_ml_sdk._search_indexes.search_index.BaseSearchIndex
+
+.. autoclass:: yandex_cloud_ml_sdk._datasets.domain.BaseDatasets
+
+.. autoclass:: yandex_cloud_ml_sdk._datasets.dataset.BaseDataset
+
+.. autoclass:: yandex_cloud_ml_sdk._tuning.domain.BaseTuning

docs/conf.py

@@ -29,6 +29,10 @@
     'exclude-members': '__weakref__',
 }
 autodoc_inherit_docstrings = True
+autodoc_type_aliases = {
+    'BaseSDK': 'yandex_cloud_ml_sdk._sdk.BaseSDK',
+    'asyncio': 'asyncio'
+}
 
 intersphinx_mapping = {
     'grpc': ('https://grpc.github.io/grpc/python/', None),
@@ -39,6 +43,7 @@
 always_use_bars_union = True
 typehints_defaults = 'comma'
 
+nitpicky = True
 
 # -- Options for HTML output -------------------------------------------------
 

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+sphinx-autodoc-typehints

tox.ini

@@ -45,7 +45,6 @@ commands =
 [testenv:docs]
 basepython = python3.12
 deps =
-    sphinx
-    sphinx-autodoc-typehints
+    -r docs/requirements.txt
 commands =
-    sphinx-build docs docs/_build {posargs}
+    sphinx-build docs docs/_build -W {posargs}