search

kedro-org / kedro-plugins

First-party plugins maintained by the Kedro team.
Apache License 2.0
92 stars 89 forks source link

Create kedro-datasets project on Read the Docs #261

Closed astrojuanlu closed 1 year ago

astrojuanlu commented 1 year ago

Description

As per title.

Context

Faulty docstrings on kedro-datasets is a frequent source of build failures. Recently we started having problems because of 1 broken URL as well. (Links to be filled.)

kedro-datasets should have its own documentation and be configured as a subproject (see https://github.com/kedro-org/kedro/issues/2600 for a related discussion).

Possible Implementation

https://docs.readthedocs.io/en/stable/guides/setup/monorepo.html

Someone with admin access to this repository can set it up on Read the Docs and then give https://readthedocs.org/profiles/Juanlu001/ access.

Possible Alternatives

astrojuanlu commented 1 year ago

Another case of faulty docstring only discovered after the fact: https://github.com/kedro-org/kedro/pull/2871 I think this has affected us for every single dataset added in the past 6 months.

@stichbury Do you think we can prioritize this when I'm back? (In the meantime, someone with enough permissions can start with creating the RTD project)

merelcht commented 1 year ago

I think as a bare minimum we should just run the same checks that RTD does as a build job on kedro-datasets.

noklam commented 1 year ago

x-ref the current manual steps that I take to ensure docs will pass.

https://github.com/kedro-org/kedro/pull/2871#issuecomment-1660407132

merelcht commented 1 year ago

The RTD project for kedro-datasets has been setup https://github.com/kedro-org/kedro-plugins/pull/299, but now it needs to be configured as a subproject.

astrojuanlu commented 1 year ago

https://docs.kedro.org/projects/kedro-datasets/ 🔥

Screenshot 2023-08-15 at 12-20-01 Subprojects Read the Docs

Builds failing because we need to fill the Heap environment variables https://readthedocs.org/projects/kedro-datasets/builds/21614111/ that can be found for main Kedro here https://readthedocs.org/dashboard/kedro/environmentvariables/. My guess is that we'd want to treat all the subprojects as the same Heap property. cc @stichbury

astrojuanlu commented 1 year ago

Even if the latest builds aren't running because of the Heap properties, we now have pull request builds as per #299, which means that, hopefully, we'll never get faulty docstrings again. Worth testing this though!

For the rest of the follow-up tasks of subprojects, we can continue the conversation in https://github.com/kedro-org/kedro/issues/2600