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

make sphinx run again #167

Merged
merged 19 commits into from
Nov 17, 2022
Merged

make sphinx run again #167

merged 19 commits into from
Nov 17, 2022

Conversation

aaronspring
Copy link
Collaborator

@aaronspring aaronspring commented Nov 17, 2022

closes #95

@aaronspring aaronspring changed the title Update conf.py test sphinx now Nov 17, 2022
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

nbsphinx_timeout = 600
nbsphinx_execute = "never" # "auto" "always"
jupyter_execute_notebooks = "off"
nb_execution_timeout = 120
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking into the raw log of the docs build, I found a CellTimeoutError. Fixing with https://myst-nb.readthedocs.io/en/latest/configuration.html

@aaronspring aaronspring mentioned this pull request Nov 17, 2022
@aaronspring aaronspring marked this pull request as ready for review November 17, 2022 12:07
@aaronspring
Copy link
Collaborator Author

aaronspring commented Nov 17, 2022

finally works, see https://xbitinfo--167.org.readthedocs.build/en/167/quick-start.html

however keepbits from plot and algorithm

image
and
image
dont match!

The input is float64 but the graphic doesnt show that. @observingClouds see the problem?

@aaronspring aaronspring self-assigned this Nov 17, 2022
@aaronspring aaronspring added the documentation Improvements or additions to documentation label Nov 17, 2022
@aaronspring
Copy link
Collaborator Author

temporarily fixed with input.astype("float32")

@aaronspring aaronspring changed the title test sphinx now make sphinx run again Nov 17, 2022
@@ -29,9 +27,9 @@
"metadata": {},
"outputs": [],
"source": [
"ds = xr.tutorial.load_dataset(\"eraint_uvz\")\n",
"ds = xr.tutorial.load_dataset(\"eraint_uvz\").astype(\"float32\")\n",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you approve of this fix in the quickstart or better take another sample dataset?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is okay for now. Could you mention this specific commit in issue #168 so that we do not forget to revert it.
Other datasets in the tutorial are often also offset/scale compressed leading to float64. The best alternative might be "ROMS_example", but since the coordinates are quite complex it might cause some new issues.

Copy link
Owner

@observingClouds observingClouds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Glad to see that this is finally working! Great work! LGTM!

@aaronspring aaronspring merged commit b28f78d into main Nov 17, 2022
@aaronspring aaronspring deleted the test_sphinx branch November 17, 2022 22:44
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.

sphinx readthedocs notebook wont execute
2 participants