-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Switch to sphinx-inline-tabs for tabs #9008
Conversation
/cc @pfmoore @shireenrao :) |
https://sphinx-inline-tabs.readthedocs.io/en/latest/index.html -- in case you're looking for the docs. |
These look great!! |
The preview at https://pip--9008.org.readthedocs.build/en/9008/installing/ seems to be broken... |
Sorry I was commenting on the examples on the readthedocs page.. |
Of course readthedocs uses it's own custom HTML builder called |
So does that imply we need to request some change from RTD before this could be merged? |
Nah -- pradyunsg/sphinx-inline-tabs@ace2f95 is sufficient. I'll wait for a few minutes before a close-reopen here. |
(Offtopic) Just while I think, would this also be something to consider if we wanted to start using MyST? |
As in? It'll work the same way -- see https://github.com/pradyunsg/sphinx-inline-tabs/blame/main/docs/usage.md for how the MyST vs reST syntax is different. They both work the same way, and invoke the exact same code and whatnot. |
Sorry, drive by comments while I'm doing something else. As in, does the MyST parser need to have explicit support for the RTD builders, and if so we should check that it does. |
Ah, no. They're affecting separate components. The "builder" is the bit that decides where to put the generated HTML files. Those HTML files are provided by rendering the "theme" using the "parsed content". MyST generates the parsed content, and hence is a drop-in replacement, without needing support in any other part of the pipeline. FWIW, the documentation I've linked to is MyST based and is on RTD without issues. :) |
I'mma click merge on this now -- since no one has raised concerns against doing this, and I genuinely think this looks much better. :) Also, the longer this stays open, the greater the chances of conflicts and I dealt w/ enough of those for 20.2.4. Reverts are cheap too. |
The pip docs look really good! |
@shireenrao IDK if you've seen #9012 -- you might be interested in that. ;) |
Woah!! Thats super clean! Kudos on making such a sleek looking theme! |
Follow up to #8589, to give us significantly better looking tabs.