Admonitions#
Admonitions are specially formatted blocks that highlight important information in the documentation. This page shows how the Ansys Sphinx Theme renders admonitions.
The examples shown below are derived from the PyData Sphinx Theme project, copyrighted by pandas, 2018. Original examples can be found in Examples in the PyData Sphinx Theme documentation. These examples are licensed under the BSD 3-Clause License.
The examples included below in this page were originally copyrighted and licensed as follows:
Copyright (c) 2021, Pradyun Gedam. Licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (SPDX-License-Identifier: CC-BY-SA-4.0), as specified by the PyData Sphinx Theme in their examples.
Admonitions#
Sphinx provides several different types of admonitions.
topic
#
admonition
#
The one with the custom titles
It’s got a certain charm to it.
We also support italic, bold, code
, links, and more.
attention
#
caution
#
danger
#
error
#
hint
#
Hint
Insulators insulate, until they are subject to ______ voltage.
We also support italic, bold, code
, links, and more.
important
#
Important
Tech is not neutral, nor is it apolitical.
We also support italic, bold, code
, links, and more.
note
#
seealso
#
tip
#
todo
#
warning
#
versionadded
#
Added in version v0.1.1: Here’s a version added message.
We also support italic, bold, code
, links, and more.
versionchanged
#
Changed in version v0.1.1: Here’s a version changed message.
We also support italic, bold, code
, links, and more.
deprecated
#
Deprecated since version v0.1.1: Here’s a deprecation message.
We also support italic, bold, code
, links, and more.
versionremoved
#
Removed in version v0.1.1: Here’s a version removed message.
We also support italic, bold, code
, links, and more.