search

sphinx-themes / sphinx-themes.org

A showcase for Sphinx documentation themes
https://sphinx-themes.org
BSD 2-Clause "Simplified" License
236 stars 44 forks source link

Address initial feedback from April 2021 revamp #74

Closed pradyunsg closed 3 years ago

pradyunsg commented 3 years ago

/cc @choldgraf @jorisvandenbossche for pydata-sphinx-theme re-addition -- feedback welcome on how to handle the way that pydata-sphinx-theme handles navigation!

pradyunsg commented 3 years ago

feedback welcome on how to handle the way that pydata-sphinx-theme handles navigation!

I'm deploying this right now, but feel free to reply on this PR about this (or to file a new issue to discuss this).

I don't think pydata-sphinx-theme is being fairly represented here, so, I'd like to hear feedback on how to handle it.

jorisvandenbossche commented 3 years ago

Nice revamp!

Yeah, generally the pydata-sphinx-theme is targeting sites that have a few top-level items. While the current sample docs is rather written for a sidebar. I don't know what the best solution would be for this, apart from having two versions of the demo docs .. Although it might be that just replacing the main index.rst could already be sufficient without having to duplicate all the rest.

pradyunsg commented 3 years ago

One option is to have an alternative root_doc I think. Setting it to something like index-nested-nav.rst, with that being a better structured for pydata-sphinx-theme?

I guess how the sphinx-basic-ng conversation goes around handling navigation will inform the choices to make here.

choldgraf commented 3 years ago

Something like that sounds reasonable to me, I think there is value in encouraging people to try the topbar-style layout in more themes, even if it is a bit different from traditional sphinx sites

pradyunsg commented 3 years ago

It might even make sense to just have that by default maybe? IDK yet.

I'll experiment and see if I can come up with something that just works for everything.