search

pydata / xarray

N-D labeled arrays and datasets in Python
https://xarray.dev
Apache License 2.0
3.52k stars 1.05k forks source link

Why did you go to the sphinx-book-theme instead of the pydata-sphinx-theme ? #8701

Open 12rambau opened 5 months ago

12rambau commented 5 months ago

Is your feature request related to a problem?

Let's face it, it's not a problem per se, I really liked the new documentation and the recent logo revamp.

I think xarray is a big lib and has thus a very dense documentation (many pages, many API entries etc). This is exactly why the pydata-sphinx-theme has been designed for. Using the top navigation top bar you can facilitate reading within the documentation by reducing the burden on the primary sidebar. At first I though you went full on executable book which would require to use the sphinx-book-theme but as you are still relying on .rst files and pure sphinx, changing theme is still an option.

Was it already discussed somewhere or is the door still open for modifications ?

Describe the solution you'd like

Slightly change the documentation conf.py to rely on the pydata-sphinx-theme.

Additional context

full disclaimer, I'm a maintainer of the pydata-sphinx-theme (that lives in the very same organization).

welcome[bot] commented 5 months ago

Thanks for opening your first issue here at xarray! Be sure to follow the issue template! If you have an idea for a solution, we would really welcome a Pull Request with proposed changes. See the Contributing Guide for more. It may take us a while to respond here, but we really value your contribution. Contributors like you help make xarray better. Thank you!

dcherian commented 5 months ago

This seems like a good idea, and a good way to move tutorial.xarray.dev over to the main docs site.