Skip to content

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

Closed
wants to merge 7 commits into from
Closed

Conversation

DON-BRAN
Copy link
Contributor

fixes #1208

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Copy link
Member

@joshmoore joshmoore left a 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.

Screen Shot 2022-10-25 at 16 31 57


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

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.

Copy link
Contributor Author

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 🙂

Copy link
Contributor Author

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

image

But when it builds on the server the bullet points get extra white spaces between them

image

Found this on stack overflow https://stackoverflow.com/questions/67542699/readthedocs-sphinx-not-rendering-bullet-list-from-rst-file

Copy link
Member

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

Copy link
Contributor Author

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 :)

Copy link
Member

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.

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Nov 15, 2022
@jhamman
Copy link
Member

jhamman commented Dec 7, 2023

This has unfortunately gone stale. Will it be revived or should we close this?

@jhamman jhamman added stale documentation Improvements to the documentation labels Dec 7, 2023
@jhamman
Copy link
Member

jhamman commented Feb 13, 2024

Closing as stale. We'll keep the original feature request open.

@jhamman jhamman closed this Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation needs release notes Automatically applied to PRs which haven't added release notes stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance tutorial by adding Prerequisites, Understanding the example code, What is an N-dimensional array?
4 participants