-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Add warning when browsing developer docs #6896
Conversation
The theme has the option to display an announcement banner which is displayed at the top of the screen, but will disappear once they start scrolling. I think that would be a perfect fit for what you want to achieve? |
Additionally, we could also color the version switcher like SciPy does. That might be another hint to the user. |
By the way, how is this relevant to the 0.21 release? It shouldn't be affected by this change in any way. |
Should I update the PR with my suggested changes? |
Can you make the banner only appear on the dev version? Ah, yes, that should be easy since it happens in conf.py. Go ahead and give it a try. |
We use these templates in networkx:
When I make a release, I do the following in the same commit where I update the release version
Then I add it back when I bump the release version after the release. I haven't been good about it recently, I should update the NX release process documentation so I don't forget. But then I am supposed to manually insert
In the past, I just use At any rate, it would make sense to make this consistent between projects. |
This is now supported by pydata-sphinx-theme; we just need to activate that feature. |
Continued in #7139. |
This adds a warning banner to the top of the current "article" when the dev docs are being browsed (perhaps you want to look at stable docs?).
Unfortunately, I cannot figure out how to coax pydata-sphinx-theme into rendering the breadcrums either underneath or above the block.
Any ideas?
/cc @lagru