Skip to content

Commit bed35eb

Browse files
committed
add docs
1 parent 218c664 commit bed35eb

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/user_guide/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -74,5 +74,6 @@ accessibility
7474
analytics
7575
static_assets
7676
performance
77+
warnings
7778
readthedocs
7879
```

docs/user_guide/warnings.rst

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
Theme changes, deprecations, and warnings
3+
=========================================
4+
5+
Generally speaking, the best source of information about changes to the theme will be the release changelog.
6+
We try to avoid raising warnings within theme code, which means sometimes the theme will change (perhaps significantly) without deprecation warnings or other alerts.
7+
Still, we occasionally do warn about things like (upcoming) changes to the theme's default config values.
8+
If you prefer *not* to receive such warnings, there is a config value to suppress them:
9+
10+
.. code-block::
11+
:caption: conf.py
12+
13+
html_theme_options = {
14+
"surface_warnings": False
15+
}

0 commit comments

Comments
 (0)