From 339de8d54129a85a55df970be1764e1945eab992 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Luis=20Cano=20Rodr=C3=ADguez?= Date: Tue, 23 May 2023 23:38:56 +0200 Subject: [PATCH] docs: Fix APIDataSet docstring (#220) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fix APIDataSet docstring Signed-off-by: Juan Luis Cano Rodríguez * Add release notes Signed-off-by: Juan Luis Cano Rodríguez * Separate [docs] extras from [all] in kedro-datasets Fix gh-143. Signed-off-by: Juan Luis Cano Rodríguez --------- Signed-off-by: Juan Luis Cano Rodríguez --- kedro-datasets/RELEASE.md | 1 + .../kedro_datasets/api/api_dataset.py | 4 ++-- kedro-datasets/setup.py | 22 +++++++++---------- 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/kedro-datasets/RELEASE.md b/kedro-datasets/RELEASE.md index ed347ca60..8406a063c 100644 --- 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 index 82bba3546..0929f56fe 100644 --- 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 index f5c5d931a..e69de8fa9 100644 --- a/kedro-datasets/setup.py +++ b/kedro-datasets/setup.py @@ -81,17 +81,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), @@ -128,6 +117,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,