Doc alabaster theme #139
Doc alabaster theme #139
Conversation
It's built-in, arguably leaner than the RTD theme, and the output does not depend on whether the RTD theme is installed or not. Furthermore, the RTD theme currently depends on sphinx <6, and installing the theme leads to downgrading Sphinx to 5.3.0.
Add the index page to the toctree so it's included in the navigation bar as well as table of contents, and easier to find than just via the main title link. Use the special 'self' reference for this.
The theme supports GitHub banners and whatnot, but stick to the more quiet regular link in the sidebar. https://alabaster.readthedocs.io/en/latest/customization.html
This is directly from Alabaster documentation [1]. Everything appears to work without it, but this allows us to customize it later on. [1] https://alabaster.readthedocs.io/en/latest/installation.html
|
The changes look good to me, though I haven't delved into the theme configuration options to know any better.
It's ok with me, but I'm curious, why are you making this a requirement to get the version stuff working? |
The multiversion thing is a can of worms, I'm afraid. I'm not really happy with anything that's readily available, and the RTD flyout menu is their proprietary thing. So I'm looking at hacking the theme to add the version menu to it. It's not necessarily tied to the alabaster theme, but it's easier to work from with just one theme in mind. Alabaster is strictly not part of Sphinx, but it's the default theme and always ships with Sphinx, so dropping the sphinx_rtd_theme reduces moving parts. |
I merged with that, thanks, and now you can compare the differences at RTD: |
|
Also posted #140 to demo how it would look like. |
I was reminded by #137 (comment) that I've got this branch where I'm experimenting with displaying documentation version more prominently and potentially adding multiple version support. I'm not quite there yet, but here's some early stuff. Not much point in hacking on the alabaster theme to display versions if we disagree on switching to it!