Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Silence warnings #1542

Merged
merged 7 commits into from Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/_extension/gallery_directive.py
Expand Up @@ -75,7 +75,7 @@ def run(self) -> List[nodes.Node]:
path_doc = Path(path_doc).parent
path_data = (path_doc / path_data_rel).resolve()
if not path_data.exists():
logger.warn(f"Could not find grid data at {path_data}.")
logger.info(f"Could not find grid data at {path_data}.")
nodes.text("No grid data found at {path_data}.")
return
yaml_string = path_data.read_text()
Expand All @@ -86,7 +86,6 @@ def run(self) -> List[nodes.Node]:
# and generate a card item for each of them
grid_items = []
for item in safe_load(yaml_string):

# remove parameters that are not needed for the card options
title = item.pop("title", "")

Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Expand Up @@ -48,6 +48,8 @@
"_extension.gallery_directive",
]

jupyterlite_config = "jupyterlite_config.json"

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

Expand Down
7 changes: 7 additions & 0 deletions docs/jupyterlite_config.json
@@ -0,0 +1,7 @@
{
"LiteBuildConfig": {
"Application": {
"log_level": 40
}
}
}
1 change: 1 addition & 0 deletions docs/user_guide/index.md
Expand Up @@ -74,5 +74,6 @@ accessibility
analytics
static_assets
performance
warnings
readthedocs
```
15 changes: 15 additions & 0 deletions docs/user_guide/warnings.rst
@@ -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
}
10 changes: 9 additions & 1 deletion noxfile.py
Expand Up @@ -77,6 +77,8 @@ def docs(session: nox.Session) -> None:
"-v",
"-w",
"warnings.txt",
# suppress Py3.11's new "can't debug frozen modules" warning
env=dict(PYDEVD_DISABLE_FILE_VALIDATION="1"),
)
session.run("python", "tests/utils/check_warnings.py")

Expand All @@ -92,7 +94,13 @@ def docs_live(session: nox.Session) -> None:
"sphinx-theme-builder[cli]@git+https://github.com/pradyunsg/sphinx-theme-builder#egg=d9f620b"
)
session.run(
"stb", "serve", "docs", "--open-browser", "--re-ignore=locale|api|_build"
"stb",
"serve",
"docs",
"--open-browser",
r"--re-ignore=locale|api|_build|\.jupyterlite\.doit\.db",
# suppress Py3.11's new "can't debug frozen modules" warning
env=dict(PYDEVD_DISABLE_FILE_VALIDATION="1"),
)


Expand Down