-
-
Notifications
You must be signed in to change notification settings - Fork 329
Updated tutorial docs #1217
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
Updated tutorial docs #1217
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good structurally, though I'm not the best person to say if these URLs are the best starting points. Copying a screenshot from https://zarr--1217.org.readthedocs.build/en/1217/ in case anyone wants to give it a quick glance.
docs/tutorial.rst
Outdated
|
||
Zarr is a format used to create N-dimensional arrays with any NumPy `dtype <https://numpy.org/doc/stable/reference/arrays.dtypes.html#arrays-dtypes>`_ | ||
|
||
- Chunk arrays along any dimension |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Making these proper bullet points would be nice to save whitespace.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @joshmoore for the feedback. I will make updates 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @joshmoore, I noticed anytime i build locally I see the bullet points well represented
But when it builds on the server the bullet points get extra white spaces between them
Found this on stack overflow https://stackoverflow.com/questions/67542699/readthedocs-sphinx-not-rendering-bullet-list-from-rst-file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Edit: that CSS bug is in sphinx_rtd_theme readthedocs/sphinx_rtd_theme#1115"
Interesting. One option then would be to move to another them, e.g. https://github.com/pydata/pydata-sphinx-theme
cc: @MSanKeys963
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Edit: that CSS bug is in sphinx_rtd_theme readthedocs/sphinx_rtd_theme#1115"
Interesting. One option then would be to move to another them, e.g. https://github.com/pydata/pydata-sphinx-theme
cc: @MSanKeys963
I will like to work on the theme migration if that's voted :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest to go ahead and try it out. We can always revert.
This has unfortunately gone stale. Will it be revived or should we close this? |
Closing as stale. We'll keep the original feature request open. |
fixes #1208
TODO: