Skip to content
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 style for versionremoved directive #2086

Open
stevepiercy opened this issue Dec 20, 2024 · 3 comments · May be fixed by #2087
Open

Add style for versionremoved directive #2086

stevepiercy opened this issue Dec 20, 2024 · 3 comments · May be fixed by #2087

Comments

@stevepiercy
Copy link
Contributor

There is no style applied for the versionremoved directive. It was added in Sphinx 7.3.

Screenshot 2024-12-19 at 11 59 34 PM

I would suggest using the same color as deprecated. A removal feels as severe, if not more than, a deprecation.

I'd be happy to submit a pull request with whatever color you think is best.

@drammock
Copy link
Collaborator

I would suggest using the same color as deprecated.

+1

@stevepiercy
Copy link
Contributor Author

See also sphinx-themes/sphinx-themes.org#163 for testing the new directive.

I don't want to edit anything under the Kitchen Sink. Where should I put this snippet to test or preview until that PR gets merged?

``versionremoved``
==================

.. versionremoved:: v0.1.1

   Here's a version removed message.

   We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/>`_, and more.

@stevepiercy
Copy link
Contributor Author

Here's a pull request preview from Plone Sphinx Theme.

https://plone-sphinx-theme--48.org.readthedocs.build/reference/special-theme-elements.html#versionremoved

Screenshot 2024-12-20 at 2 39 47 AM

Screenshot 2024-12-20 at 2 39 58 AM

PR incoming.

stevepiercy added a commit to stevepiercy/pydata-sphinx-theme that referenced this issue Dec 20, 2024
Note that I added a snippet in the Kitchen Sink to preview the change. I have an open PR in sphinx-themes/sphinx-themes.org#163 to add it upstream. I can remove this snippet, if you prefer, or you can clobber it the next time you run a sync.

I'll also attach a screenshot.

- Closes pydata#2086
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants