-
Notifications
You must be signed in to change notification settings - Fork 296
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -74,5 +74,6 @@ accessibility | |
analytics | ||
static_assets | ||
performance | ||
warnings | ||
readthedocs | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
|
||
Theme changes, deprecations, and warnings | ||
========================================= | ||
|
||
Generally speaking, the best source of information about changes to the theme will be the release changelog. | ||
We try to avoid raising warnings within theme code, which means sometimes the theme will change (perhaps significantly) without deprecation warnings or other alerts. | ||
Still, we occasionally do warn about things like (upcoming) changes to the theme's default config values. | ||
If you prefer *not* to receive such warnings, there is a config value to suppress them: | ||
|
||
.. code-block:: | ||
:caption: conf.py | ||
html_theme_options = { | ||
"surface_warnings": False | ||
} |