changed documentation theme to pydata_sphinx_theme by DON-BRAN · Pull Request #1242 · zarr-developers/zarr-python

DON-BRAN · 2022-11-02T18:31:51Z

Implementation of the suggestion here #1217

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)

joshmoore · 2022-11-02T18:36:38Z

Wow! That's quite the update.

jakirkham · 2022-11-02T18:40:29Z

cc @MSanKeys963

sanketverma1704 · 2022-11-05T21:48:04Z

Hi @DON-BRAN. Thanks for sending the PR. The change looks good.

Wow! That's quite the update.

Indeed, @joshmoore.

@DON-BRAN, I was wondering if there's a possibility to restructure the homepage of Zarr documentation to something like this?

Seems like most of the OSS projects using pydata-sphinx-theme are using a similar format for their homepage.

DON-BRAN · 2022-11-07T08:29:36Z

Hi @DON-BRAN. Thanks for sending the PR. The change looks good.

Wow! That's quite the update.

Indeed, @joshmoore.

@DON-BRAN, I was wondering if there's a possibility to restructure the homepage of Zarr documentation to something like this?

Seems like most of the OSS projects using pydata-sphinx-theme are using a similar format for their homepage.

Hello @MSanKeys963, i'll be glad to work on that. I will begin looking into it.
I'll drop any questions I have under this PR thread

rabernat · 2022-11-18T16:47:38Z

Folks looking to preview this site can go straight to https://zarr--1242.org.readthedocs.build/en/1242/

My overall impression is that this is a great change. I support migrating to pydata_sphinx_theme. 🎉

We should probably do a thorough line-be-line comparison of old vs new site to make sure all formatting and other features make it through cleanly.

Mubarraqqq · 2022-11-18T19:06:44Z

Alright @rabernat

docs/index.rst

sanketverma1704 · 2022-12-12T19:03:10Z

docs/getting_started.rst

+:user:`Alistair Miles <alimanfoo>`
+:user:`Altay Sansal <tasansal>`
+:user:`Anderson Banihirwe <andersy005>`
+:user:`Andrew Fulton <andrewfulton9>`
+:user:`Andrew Thomas <amcnicho>`
+:user:`Anthony Scopatz <scopatz>`
+:user:`Attila Bergou <abergou>`
+:user:`BGCMHou <BGCMHou>`
+:user:`Ben Jeffery <benjeffery>`
+:user:`Ben Williams <benjaminhwilliams>`
+:user:`Boaz Mohar <boazmohar>`
+:user:`Charles Noyes <CSNoyes>`
+:user:`Chris Barnes <clbarnes>`
+:user:`David Baddeley <David-Baddeley>`
+:user:`Davis Bennett <d-v-b>`
+:user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`
+:user:`Eduardo Gonzalez <eddienko>`
+:user:`Elliott Sales de Andrade <QuLogic>`
+:user:`Eric Prestat <ericpre>`
+:user:`Eric Younkin <ericgyounkin>`
+:user:`Francesc Alted <FrancescAlted>`
+:user:`Greggory Lee <grlee77>`
+:user:`Gregory R. Lee <grlee77>`
+:user:`Ian Hunt-Isaak <ianhi>`
+:user:`James Bourbeau <jrbourbeau>`
+:user:`Jan Funke <funkey>`
+:user:`Jerome Kelleher <jeromekelleher>`
+:user:`Joe Hamman <jhamman>`
+:user:`Joe Jevnik <llllllllll>`
+:user:`John Kirkham <jakirkham>`
+:user:`Josh Moore <joshmoore>`
+:user:`Juan Nunez-Iglesias <jni>`
+:user:`Justin Swaney <jmswaney>`
+:user:`Mads R. B. Kristensen <madsbk>`
+:user:`Mamy Ratsimbazafy <mratsim>`
+:user:`Martin Durant <martindurant>`
+:user:`Matthew Rocklin <mrocklin>`
+:user:`Matthias Bussonnier <Carreau>`
+:user:`Mattia Almansi <malmans2>`
+:user:`Noah D Brenowitz <nbren12>`
+:user:`Oren Watson <orenwatson>`
+:user:`Pavithra Eswaramoorthy <pavithraes>`
+:user:`Poruri Sai Rahul <rahulporuri>`
+:user:`Prakhar Goel <newt0311>`
+:user:`Raphael Dussin <raphaeldussin>`
+:user:`Ray Bell <raybellwaves>`
+:user:`Richard Scott <RichardScottOZ>`
+:user:`Richard Shaw <jrs65>`
+:user:`Ryan Abernathey <rabernat>`
+:user:`Ryan Williams <ryan-williams>`
+:user:`Saransh Chopra <Saransh-cpp>`
+:user:`Sebastian Grill <yetyetanotherusername>`
+:user:`Shikhar Goenka <shikharsg>`
+:user:`Shivank Chaudhary <Alt-Shivam>`
+:user:`Stephan Hoyer <shoyer>`
+:user:`Stephan Saalfeld <axtimwalde>`
+:user:`Tarik Onalan <onalant>`
+:user:`Tim Crone <tjcrone>`
+:user:`Tobias Kölling <d70-t>`
+:user:`Tom Augspurger <TomAugspurger>`
+:user:`Tom White <tomwhite>`
+:user:`Tommy Tran <potter420>`
+:user:`Trevor Manz <manzt>`
+:user:`Vincent Schut <vincentschut>`
+:user:`Vyas Ramasubramani <vyasr>`
+:user:`Zain Patel <mzjp2>`
+:user:`gsakkis`
+:user:`hailiangzhang <hailiangzhang>`
+:user:`pmav99 <pmav99>`
+:user:`sbalmer <sbalmer>`


Hi @DON-BRAN. Currently, the Acknowledgements are shown like this. 👇🏻
I think this is not reader-friendly. Do you think we can have a bulleted list of items?

sanketverma1704 · 2022-12-12T19:06:28Z

Hi @DON-BRAN. Thanks for working on the change.
I've gone through it and added some comments above. Let me know what you think.

Also, can we add a Twitter icon with a hyperlink at the top right?

Co-authored-by: Sanket Verma <svsanketverma5@gmail.com>

DON-BRAN · 2022-12-13T09:53:44Z

Hi @DON-BRAN. Thanks for working on the change. I've gone through it and added some comments above. Let me know what you think.

Also, can we add a Twitter icon with a hyperlink at the top right?

Hi @MSanKeys963, thank you for the review. I will make the necessary changes.
About the Twitter Icon I believe it's possible.

joshmoore · 2022-12-14T16:06:05Z

@zarr-developers/python-core-devs, this is moving toward completion and there don't look to be any down votes (only 4 likes on twitter though ;) )

One thing to be aware of: ⚠️ the URLs for the landing page (e.g. https://zarr.readthedocs.io/en/stable/#installation) have changed (e.g. https://zarr--1242.org.readthedocs.build/en/1242/installation.html)

joshmoore · 2022-12-14T19:17:59Z

@normanrz suggested client-side javascript for the redirects like https://stackoverflow.com/a/21198129/56887

DON-BRAN · 2022-12-15T10:52:21Z

@normanrz suggested client-side javascript for the redirects like https://stackoverflow.com/a/21198129/56887

Hi @joshmoore, thank you for the review. I made some updates with regards to your review. The URL https://zarr--1242.org.readthedocs.build/en/1242/#installation now redirects to https://zarr--1242.org.readthedocs.build/en/1242/installation.html.
I'll be happy to make any further changes if necessary 🙂

joshmoore · 2022-12-15T14:57:03Z

Kudos, @DON-BRAN (and @normanrz). Could you add all the other redirects and then I'd be a very happy camper ⛺

joshmoore · 2023-01-12T15:30:23Z

@DON-BRAN: do you see getting to the other redirects?

joshmoore

Added a few more comments from looking at https://zarr--1242.org.readthedocs.build/en/1242/ closely while looking for redirects. We could potentially handle these in follow-ups though.

One way or the other, it's a huge improvement, thanks @DON-BRAN!

joshmoore · 2023-01-16T13:57:31Z

docs/index.rst

+.. _zarr_docs_mainpage:
+
+******************
+Zarr documentation


Should this perhaps be Zarr-Python?

+1 for Zarr-Python.

+1 for Zarr-Python

joshmoore · 2023-01-16T13:58:35Z

docs/getting_started.rst

+If you are using Zarr, we would `love to hear about it
+<https://github.com/zarr-developers/community/issues/19>`_.
+
+Acknowledgments


Not sure acknowledgements belongs under "contributing"

Yes, I agree. Can we have a separate page for Acknowledgements, @ DON-BRAN?

Yes, I do agree with Acknowledgements being on a separate, it is way better and stands out in a nice way

joshmoore · 2023-01-16T13:58:47Z

docs/getting_started.rst

+* :user:`pmav99 <pmav99>`
+* :user:`sbalmer <sbalmer>`
+
+Contents


Not sure "Contents" and below belongs under "Getting started"

I think we should remove Tutorials, API Reference, Specifications and Release Notes from 'Contents' as they're already covered in the header.

We can leave Contributing to Zarr on 'Getting Started' if we want.

Also, maybe this is for me only, but I'm getting 404 for all of the various Tutorials and Release Notes when accessing from here.

Can you please check @DON-BRAN and @joshmoore?

Yes, there's not really any need for the reiteration under Getting started though it could still be left so, but avoiding it looking bulky and getting it more organized, i suggest they could be taken out

@MSanKeys963 Everything opens fine for me, and looking really great

@MSanKeys963 Everything opens fine for me, and looking really great

👍🏻

Can you please remove the sections mentioned above and add a separate page for acknowledgements?

DON-BRAN · 2023-01-17T13:27:00Z

Hello @joshmoore @MSanKeys963 , I made updates as suggested above here are some snapshots of my changes

I added the a link to the zar-dev website to the top of the page and removed the view homepage section which had previously pointed to the link

I added the license, and acknowledgments pages to the more section of the navbar

I added the installation page to the side of the getting started page and removed the contents section

and also added the acknowledges page to the redirect list. Please let me know if there are any more changes you will like me to do. I will get on them as soon as possible 🙂

joshmoore · 2023-01-17T15:34:18Z

docs/getting_started.rst

-    license
-    View homepage <https://zarr.dev/>
-
-Indices and tables


Can we maybe think of some place to have this information?

Hi @joshmoore, could it be placed at the more section at the top? Maybe on it's own page Indices and tables

I pushed a commit seeing how it looks on the api page.

joshmoore · 2023-01-18T17:35:28Z

DON-BRAN · 2023-01-19T07:05:49Z

This is a perfect fit 🚀

joshmoore · 2023-01-19T14:37:30Z

Perhaps last call for feedback, @zarr-developers/python-core-devs!

joshmoore · 2023-02-02T15:01:04Z

Rolling this into the upcoming 2.14. Thanks, @DON-BRAN!

github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Nov 29, 2022

changed documentation theme to pydata_sphinx_theme

57db9be

DON-BRAN force-pushed the update_theme branch from 131ad51 to 57db9be Compare December 8, 2022 19:16

updated documentation layout

6da674d

sanketverma1704 reviewed Dec 12, 2022

View reviewed changes

docs/index.rst Outdated Show resolved Hide resolved

sanketverma1704 reviewed Dec 12, 2022

View reviewed changes

Update docs/index.rst

5d902c3

Co-authored-by: Sanket Verma <svsanketverma5@gmail.com>

Updated Acknowledgements section and added twitter icon

e3b7657

Added client-side javascript redirects

6dd8850

Add more redirects

6496cbf

joshmoore reviewed Jan 16, 2023

View reviewed changes

DON-BRAN added 3 commits January 16, 2023 21:06

Merge branch 'zarr-developers:main' into update_theme

f6c6738

Minor tweaks and added acknowledgments.rst

1dce04a

Added acknowledgments.html to redirect

748234d

joshmoore reviewed Jan 17, 2023

View reviewed changes

Add indices from the old main page

2ce8565

joshmoore merged commit 4dc6f1f into zarr-developers:main Feb 2, 2023

jakirkham mentioned this pull request Oct 28, 2023

Use PyData theme for docs zarr-developers/numcodecs#485

Merged

7 tasks

Uh oh!

Conversation

DON-BRAN commented Nov 2, 2022

Uh oh!

joshmoore commented Nov 2, 2022

Uh oh!

jakirkham commented Nov 2, 2022

Uh oh!

sanketverma1704 commented Nov 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DON-BRAN commented Nov 7, 2022

Uh oh!

rabernat commented Nov 18, 2022

Uh oh!

Mubarraqqq commented Nov 18, 2022

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanketverma1704 commented Dec 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DON-BRAN commented Dec 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joshmoore commented Dec 14, 2022

Uh oh!

joshmoore commented Dec 14, 2022

Uh oh!

DON-BRAN commented Dec 15, 2022

Uh oh!

joshmoore commented Dec 15, 2022

Uh oh!

joshmoore commented Jan 12, 2023

Uh oh!

joshmoore left a comment

Choose a reason for hiding this comment

Uh oh!

joshmoore Jan 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanketverma1704 Jan 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DON-BRAN commented Jan 17, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DON-BRAN Jan 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joshmoore commented Jan 18, 2023

Uh oh!

DON-BRAN commented Jan 19, 2023

Uh oh!

joshmoore commented Jan 19, 2023

Uh oh!

joshmoore commented Feb 2, 2023

sanketverma1704 commented Nov 5, 2022 •

edited

Loading

sanketverma1704 commented Dec 12, 2022 •

edited

Loading

DON-BRAN commented Dec 13, 2022 •

edited

Loading

joshmoore Jan 16, 2023 •

edited

Loading

sanketverma1704 Jan 16, 2023 •

edited

Loading

DON-BRAN Jan 17, 2023 •

edited

Loading