DOC: Add legacy directive to mark outdated objects #24939
Conversation
This mirrors the current SciPy functionality, with styling compatible with the current version of the pydata-sphinx-theme (0.13.3) used to build the docs. [skip azp][skip cirrus]
[skip azp][skip cirrus]
9f13b02 to
703ce3b
Compare
There was a problem hiding this comment.
+1 for this! Not a blocker for this PR, but perhaps this is something that can be upstreamed/packaged as an extension since multiple projects are using it (and others may be interested).
Anyways - just food for thought; we can move that discussion to a more appropriate forum!
|
Yeah, if it's useful I'm happy to do it, should not be too hard! |
There was a problem hiding this comment.
Somehow, I would have leaned towards making the function the default (or just some "this is considered legacy", and submodule/function as a word opt in to the leading sentence.
But LGTM, and I guess this is exactly what is in SciPy, so no point in bike-shedding. Should we just put in because a follow up will soon use it?
|
My proposal would be to take that in if you want to use it, and if I actually do the refactor I'll leave it more general. Just for now my concern would be to have something so similar in different projects with different defaults may be too confusing. I should be able to refactor this into a standalone soon but don't want to block usage if you folks need it :) |
|
Hi! Do you mind merging this PR? I would like to use it for e.g. |
|
Thanks all - I will follow up with the separation into a standalone package as soon as I can get to it 😄 |
This mirrors the current SciPy functionality, with styling compatible with the current version of the pydata-sphinx-theme (0.13.3) used to build the docs.
Part of #23999
EDIT: Rendered artifact of docs (showing functionality)