Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create kedro-datasets project on Read the Docs #261

Closed
astrojuanlu opened this issue Jul 10, 2023 · 6 comments
Closed

Create kedro-datasets project on Read the Docs #261

astrojuanlu opened this issue Jul 10, 2023 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@astrojuanlu
Copy link
Member

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 kedro-org/kedro#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

  • Continuing as now. Not a good look.
  • I can't think of alternatives that are reasonable.
@astrojuanlu astrojuanlu added the documentation Improvements or additions to documentation label Jul 10, 2023
@astrojuanlu
Copy link
Member Author

Another case of faulty docstring only discovered after the fact: kedro-org/kedro#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
Copy link
Member

merelcht commented Aug 1, 2023

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

@noklam
Copy link
Contributor

noklam commented Aug 1, 2023

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

kedro-org/kedro#2871 (comment)

@merelcht
Copy link
Member

The RTD project for kedro-datasets has been setup #299, but now it needs to be configured as a subproject.

@astrojuanlu
Copy link
Member Author

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
Copy link
Member Author

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 kedro-org/kedro#2600

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

3 participants