Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drammock committed Oct 29, 2023
1 parent 218c664 commit bed35eb
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/user_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,6 @@ accessibility
analytics
static_assets
performance
warnings
readthedocs
```
15 changes: 15 additions & 0 deletions docs/user_guide/warnings.rst
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
}

0 comments on commit bed35eb

Please sign in to comment.