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

Build doc as part of the CI workflow #526

Merged
merged 1 commit into from
Sep 5, 2023
Merged

Build doc as part of the CI workflow #526

merged 1 commit into from
Sep 5, 2023

Conversation

fabianp
Copy link
Collaborator

@fabianp fabianp commented Sep 4, 2023

No description provided.

@fabianp fabianp force-pushed the doc4 branch 5 times, most recently from b7ebfab to e25be68 Compare September 4, 2023 14:26
@fabianp fabianp marked this pull request as ready for review September 4, 2023 14:33
@fabianp fabianp force-pushed the doc4 branch 2 times, most recently from 2cc1ae1 to bad87bb Compare September 4, 2023 14:54
@fabianp fabianp marked this pull request as draft September 4, 2023 14:57
@fabianp fabianp force-pushed the doc4 branch 3 times, most recently from 26856b7 to cc23de0 Compare September 5, 2023 06:33
@fabianp fabianp marked this pull request as ready for review September 5, 2023 06:58
@fabianp fabianp requested a review from mblondel September 5, 2023 07:21
@mblondel
Copy link
Collaborator

mblondel commented Sep 5, 2023

Thanks a lot for doing this! What kind of failures does this detect currently? Is it mainly syntax errors in the examples and notebooks? I guess it doesn't run examples in the narrative documentation and in the docstrings yet?

@fabianp
Copy link
Collaborator Author

fabianp commented Sep 5, 2023

it currently runs things under example/ and notebooks/ (unless those notebooks that have been excluded bc they take too long). This allowed me to catch the 3 broken examples in #525 , and the missing requirements added to this PR.

Next steps would be IMO (to be done in a different PR):

@mblondel
Copy link
Collaborator

mblondel commented Sep 5, 2023

Thanks. I just wanted to test understand exactly what it tests. Completely agreed that the rest should be done separately.

@copybara-service copybara-service bot merged commit c6d51d4 into main Sep 5, 2023
@fabianp fabianp deleted the doc4 branch September 9, 2023 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants