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

Fix notebooks so they run again #16

Merged
merged 2 commits into from
Jan 19, 2024
Merged

Fix notebooks so they run again #16

merged 2 commits into from
Jan 19, 2024

Conversation

teutoburg
Copy link
Contributor

Doesn't add them in the tests, nor really brings the information in there up to date, but at least they run now.

@teutoburg teutoburg added the documentation Improvements or additions to documentation label Jan 17, 2024
@teutoburg teutoburg requested a review from hugobuddel January 17, 2024 19:19
Copy link

codecov bot commented Jan 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5674cf3) 75.82% compared to head (bfff055) 76.00%.
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #16      +/-   ##
==========================================
+ Coverage   75.82%   76.00%   +0.18%     
==========================================
  Files           9        9              
  Lines         823      821       -2     
==========================================
  Hits          624      624              
+ Misses        199      197       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hugobuddel
Copy link
Contributor

So I don't really understand, but this breaks RTD:

I think the problem is

jupyter_client.kernelspec.NoSuchKernel: No such kernel named python3

However, nothing changed in that respect, in fact, the notebooks were broken before. It seems that RTD only runs the notebooks when they are 'un-run' in the repository.

In fact, whether RTD runs the notebooks was exactly what I wanted to verify. You added the notebooks without output, that is without running them before committing, which I think was on purpose. I do like to have the notebooks as an example about 'what to expect', and their output must be available for that. I'm fine with having the notebooks without output in the repository, as long as they have output on RTD. But that is apparently broken.

I admit that having broken notebooks that do show up in the documentation is worse than having working notebooks with broken documentation, so I will approve the PR anyway.

There seems to be much more broken with RTD / our documentation though: also the log of the successful build is full of Python Exceptions. So we should fix the RTD workflow to ensure the notebooks can be ran, and that exceptions raised in the rst files will trigger a failure. This probably applies to the other repositories as well.

@teutoburg
Copy link
Contributor Author

Hmm, I missed that e.g. docs/database.rst has some code like from spextra.database import Database, which gets executed by RTD (as it should), but doesn't work anymore because of the restructuring I made. But I think it's best to address that in a separate PR, because it's not directly related to the notebooks....

@teutoburg
Copy link
Contributor Author

Oh, and I'm looking at https://readthedocs.org/projects/spextra/, not spextraHB. But that doesn't seem to build the branches...

@teutoburg teutoburg merged commit 88617a1 into master Jan 19, 2024
15 checks passed
@teutoburg teutoburg deleted the fh/notbooks branch January 19, 2024 13:39
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
None yet
Development

Successfully merging this pull request may close these issues.

2 participants