Deprecation directive appears to render incorrectly #596
-
I attempted to use sphinx's The My docstring source: """
Get an image from the screen, using the top left as the origin.
.. deprecated:: 2.7
Use :py:func:`arcade.get_screenshot` or
:py:meth:`~Window.get_screenshot` instead to ensure your
project continues working with future arcade versions!
:param int x: Left edge of capture area
:param int y: Top edge of capture area
:param int width: Width of image. Leave blank to grab everything right of x
:param int height: Height of image. Leave blank to grab everything below y
:returns: A Pillow Image
:rtype: PIL.Image.Image
""" It looks like the |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 1 reply
-
I don't believe it's supposed to be classed as an admonition. The Sphinx docs you linked say it's "similar to versionchanged", which is not an admonition either. Furo renders Note that Sphinx themes generally do not modify the HTML output of the documentation itself. When Sphinx loads a theme, it fills placeholders in the layout with the generated HTML, and the layout includes the theme's styles/scripts to define its appearance/behavior. |
Beta Was this translation helpful? Give feedback.
I don't believe it's supposed to be classed as an admonition. The Sphinx docs you linked say it's "similar to versionchanged", which is not an admonition either. Furo renders
.. deprecated::
almost identically to the other themes I've used or seen, including the main Python documentation (example).Note that Sphinx themes generally do not modify the HTML output of the documentation itself. When Sphinx loads a theme, it fills placeholders in the layout with the generated HTML, and the layout includes the theme's styles/scripts to define its appearance/behavior.