docs: Fix APIDataSet docstring (kedro-org#220)

* Fix APIDataSet docstring Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Add release notes Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Separate [docs] extras from [all] in kedro-datasets Fix kedro-orggh-143. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> --------- Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> Signed-off-by: Tom Kurian <[email protected]>
tingtingQB · May 30, 2023 · c2a7128 · c2a7128
1 parent ccec03b
commit c2a7128
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 13 deletions.
diff --git a/kedro-datasets/RELEASE.md b/kedro-datasets/RELEASE.md
@@ -3,6 +3,7 @@
 ## Major features and improvements
 
 ## Bug fixes and other changes
+* Fixed problematic docstrings causing Read the Docs builds on Kedro to fail.
 
 ## Community contributions
 

diff --git a/kedro-datasets/kedro_datasets/api/api_dataset.py b/kedro-datasets/kedro_datasets/api/api_dataset.py
@@ -54,7 +54,7 @@ class APIDataSet(AbstractDataSet[None, requests.Response]):
         >>> data = data_set.load()
 
     ``APIDataSet`` can also be used to save output on a remote server using HTTP(S)
-    methods.
+    methods. ::
 
         >>> example_table = '{"col1":["val1", "val2"], "col2":["val3", "val4"]}'
 
@@ -116,7 +116,7 @@ def __init__(
 
         Raises:
             ValueError: if both ``auth`` and ``credentials`` are specified or used
-            unsupported RESTful API method.
+                unsupported RESTful API method.
         """
         super().__init__()
 

diff --git a/kedro-datasets/setup.py b/kedro-datasets/setup.py
@@ -84,17 +84,6 @@ def _collect_requirements(requires):
     "biosequence": _collect_requirements(biosequence_require),
     "dask": _collect_requirements(dask_require),
     "databricks": _collect_requirements(databricks_require),
-    "docs": [
-        "docutils==0.16",
-        "sphinx~=3.4.3",
-        "sphinx_rtd_theme==0.4.1",
-        "nbsphinx==0.8.1",
-        "nbstripout~=0.4",
-        "sphinx-autodoc-typehints==1.11.1",
-        "sphinx_copybutton==0.3.1",
-        "ipykernel>=5.3, <7.0",
-        "myst-parser~=0.17.2",
-    ],
     "geopandas": _collect_requirements(geopandas_require),
     "holoviews": _collect_requirements(holoviews_require),
     "matplotlib": _collect_requirements(matplotlib_require),
@@ -131,6 +120,17 @@ def _collect_requirements(requires):
 }
 
 extras_require["all"] = _collect_requirements(extras_require)
+extras_require["docs"] = [
+    "docutils==0.16",
+    "sphinx~=3.4.3",
+    "sphinx_rtd_theme==0.4.1",
+    "nbsphinx==0.8.1",
+    "nbstripout~=0.4",
+    "sphinx-autodoc-typehints==1.11.1",
+    "sphinx_copybutton==0.3.1",
+    "ipykernel>=5.3, <7.0",
+    "myst-parser~=0.17.2",
+]
 
 setup(
     extras_require=extras_require,