ci: Add docs rtd check on kedro-datasets (#299)

* Try adding docs rtd check on kedro datasets

Signed-off-by: Merel Theisen <[email protected]>

* Add Read the Docs configuration for kedro-datasets

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

.github/workflows/check-plugin.yml

@@ -93,6 +93,34 @@ jobs:
       - name: Run linter
         run: make plugin=${{ inputs.plugin }} lint
 
+  RTD-build:
+    if: inputs.plugin == 'kedro-datasets'
+    defaults:
+      run:
+        shell: bash
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.8"
+      - name: Cache python packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{inputs.plugin}}-ubuntu-latest-python-"3.8"
+          restore-keys: ${{inputs.plugin}}
+      - name: Install dependencies
+        run: |
+            cd ${{ inputs.plugin }}
+            pip install ".[docs]"
+            pip install ".[test]"
+      - name: RTD build for kedro-datasets
+        run: |
+          make rtd
+
   e2e-tests:
     if: inputs.plugin != 'kedro-datasets'
     defaults:

Makefile

@@ -60,3 +60,6 @@ test-no-spark-sequential:
 # kedro-datasets/snowflake tests skipped from default scope
 test-snowflake-only:
 	cd kedro-datasets && pytest tests --no-cov --numprocesses 1 --dist loadfile -m snowflake
+
+rtd:
+	cd kedro-datasets && python -m sphinx -WETan -j auto -D language=en -b linkcheck -d _build/doctrees docs/source _build/linkcheck

kedro-datasets/.readthedocs.yaml

@@ -0,0 +1,30 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+  jobs:
+    pre_build:
+      - pip freeze
+      - python -m sphinx -WETan -j auto -D language=en -b linkcheck -d kedro-datasets/_build/doctrees kedro-datasets/docs/source kedro-datasets/_build/linkcheck
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: kedro-datasets/docs/source/conf.py
+  fail_on_warning: true
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: kedro-datasets
+      extra_requirements:
+        - docs
+        - test

kedro-datasets/docs/source/_templates/autosummary/base.rst

@@ -0,0 +1,5 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}

kedro-datasets/docs/source/_templates/autosummary/class.rst

@@ -0,0 +1,32 @@
+{{ fullname | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :undoc-members:
+   :inherited-members:
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Attributes
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block methods %}
+   {% if methods %}
+   .. rubric:: Methods
+
+   .. autosummary::
+   {% for item in all_methods %}
+      {%- if not item.startswith('_') %}
+      ~{{ name }}.{{ item }}
+      {%- endif -%}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

kedro-datasets/docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,56 @@
+{{ fullname | escape | underline }}
+
+.. rubric:: Description
+
+.. automodule:: {{ fullname }}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: autosummary/class.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: Exceptions
+
+   .. autosummary::
+      :toctree:
+      :template: autosummary/class.rst
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

kedro-datasets/docs/source/_templates/breadcrumbs.html

@@ -0,0 +1,94 @@
+{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
+
+{% if page_source_suffix %}
+{% set suffix = page_source_suffix %}
+{% else %}
+{% set suffix = source_suffix %}
+{% endif %}
+
+{# modification to enable custom github_url #}
+
+{% if meta is not defined or meta is none %}
+    {% set meta = {} %}
+{% endif %}
+
+{% if github_url is defined %}
+    {% set _dummy = meta.update({'github_url': github_url}) %}
+{% endif %}
+
+{# // modification to enable custom github_url #}
+
+{% if meta is defined and meta is not none %}
+{% set check_meta = True %}
+{% else %}
+{% set check_meta = False %}
+{% endif %}
+
+{% if check_meta and 'github_url' in meta %}
+{% set display_github = True %}
+{% endif %}
+
+{% if check_meta and 'bitbucket_url' in meta %}
+{% set display_bitbucket = True %}
+{% endif %}
+
+{% if check_meta and 'gitlab_url' in meta %}
+{% set display_gitlab = True %}
+{% endif %}
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+    {% block breadcrumbs %}
+      <li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
+        {% for doc in parents %}
+          <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
+        {% endfor %}
+      <li>{{ title }}</li>
+    {% endblock %}
+    {% block breadcrumbs_aside %}
+      <li class="wy-breadcrumbs-aside">
+        {% if hasdoc(pagename) %}
+            {% if display_github %}
+            {% if check_meta and 'github_url' in meta %}
+              <!-- User defined GitHub URL -->
+              <a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
+            {% else %}
+              <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
+            {% endif %}
+          {% elif display_bitbucket %}
+            {% if check_meta and 'bitbucket_url' in meta %}
+              <!-- User defined Bitbucket URL -->
+              <a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
+            {% else %}
+              <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
+            {% endif %}
+          {% elif display_gitlab %}
+            {% if check_meta and 'gitlab_url' in meta %}
+              <!-- User defined GitLab URL -->
+              <a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
+            {% else %}
+              <a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
+            {% endif %}
+          {% elif show_source and source_url_prefix %}
+            <a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
+          {% elif show_source and has_source and sourcename %}
+            <a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
+          {% endif %}
+        {% endif %}
+      </li>
+    {% endblock %}
+  </ul>
+
+  {% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
+  <div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
+      {% if next %}
+        <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+      {% endif %}
+      {% if prev %}
+        <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      {% endif %}
+  </div>
+  {% endif %}
+  <hr/>
+</div>

kedro-datasets/docs/source/_templates/layout.html

@@ -0,0 +1,8 @@
+{% extends "!layout.html" %}
+
+{%- block extrahead %}
+<script type="text/javascript">
+  window.heap=window.heap||[],heap.load=function(e,t){window.heap.appid=e,window.heap.config=t=t||{};var r=document.createElement("script");r.type="text/javascript",r.async=!0,r.src="https://cdn.heapanalytics.com/js/heap-"+e+".js";var a=document.getElementsByTagName("script")[0];a.parentNode.insertBefore(r,a);for(var n=function(e){return function(){heap.push([e].concat(Array.prototype.slice.call(arguments,0)))}},p=["addEventProperties","addUserProperties","clearEventProperties","identify","resetIdentity","removeEventProperty","setEventProperties","track","unsetEventProperty"],o=0;o<p.length;o++)heap[p[o]]=n(p[o])};
+  heap.load({{ "2164194004" | env_override }});{# 2164194004 coresponds to the Development environment #}
+</script>
+{% endblock %}

kedro-datasets/docs/source/index.rst

@@ -0,0 +1,22 @@
+.. Kedro documentation master file, created by
+   sphinx-quickstart on Mon Dec 18 11:31:24 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+
+API documentation
+=================
+
+.. autosummary::
+   :toctree:
+   :caption: API documentation
+   :template: autosummary/module.rst
+   :recursive:
+
+   kedro_datasets
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`

kedro-datasets/docs/source/kedro_datasets.rst

@@ -0,0 +1,57 @@
+kedro_datasets
+==============
+
+.. rubric:: Description
+
+.. automodule:: kedro_datasets
+
+.. rubric:: Classes
+
+.. autosummary::
+   :toctree:
+   :template: autosummary/class.rst
+
+   kedro_datasets.api.APIDataSet
+   kedro_datasets.biosequence.BioSequenceDataSet
+   kedro_datasets.dask.ParquetDataSet
+   kedro_datasets.databricks.ManagedTableDataSet
+   kedro_datasets.email.EmailMessageDataSet
+   kedro_datasets.geopandas.GeoJSONDataSet
+   kedro_datasets.holoviews.HoloviewsWriter
+   kedro_datasets.json.JSONDataSet
+   kedro_datasets.matplotlib.MatplotlibWriter
+   kedro_datasets.networkx.GMLDataSet
+   kedro_datasets.networkx.GraphMLDataSet
+   kedro_datasets.networkx.JSONDataSet
+   kedro_datasets.pandas.CSVDataSet
+   kedro_datasets.pandas.DeltaTableDataSet
+   kedro_datasets.pandas.ExcelDataSet
+   kedro_datasets.pandas.FeatherDataSet
+   kedro_datasets.pandas.GBQQueryDataSet
+   kedro_datasets.pandas.GBQTableDataSet
+   kedro_datasets.pandas.GenericDataSet
+   kedro_datasets.pandas.HDFDataSet
+   kedro_datasets.pandas.JSONDataSet
+   kedro_datasets.pandas.ParquetDataSet
+   kedro_datasets.pandas.SQLQueryDataSet
+   kedro_datasets.pandas.SQLTableDataSet
+   kedro_datasets.pandas.XMLDataSet
+   kedro_datasets.pickle.PickleDataSet
+   kedro_datasets.pillow.ImageDataSet
+   kedro_datasets.plotly.JSONDataSet
+   kedro_datasets.plotly.PlotlyDataSet
+   kedro_datasets.polars.CSVDataSet
+   kedro_datasets.redis.PickleDataSet
+   kedro_datasets.snowflake.SnowparkTableDataSet
+   kedro_datasets.spark.DeltaTableDataSet
+   kedro_datasets.spark.SparkDataSet
+   kedro_datasets.spark.SparkHiveDataSet
+   kedro_datasets.spark.SparkJDBCDataSet
+   kedro_datasets.spark.SparkStreamingDataSet
+   kedro_datasets.svmlight.SVMLightDataSet
+   kedro_datasets.tensorflow.TensorFlowModelDataSet
+   kedro_datasets.text.TextDataSet
+   kedro_datasets.tracking.JSONDataSet
+   kedro_datasets.tracking.MetricsDataSet
+   kedro_datasets.video.VideoDataSet
+   kedro_datasets.yaml.YAMLDataSet