search

holoviz-dev / nbsite

Build a tested, sphinx-based website from notebooks
https://nbsite.pyviz.org
BSD 3-Clause "New" or "Revised" License
28 stars 14 forks source link

Add suppress-warnings to shared_conf.py #265

Closed hoxbro closed 1 year ago

hoxbro commented 1 year ago

This suppresses the following warnings (which pollute the log). 

(WARNING/2) Document headings start at H2, not H1 [myst.header]

WARNING: skipping unknown output mime type: application/vnd.holoviews_exec.v0+json [mystnb.unknown_mime_type]

WARNING: 'myst' reference target not found: ../../user_guide/Widgets.ipynb
maximlt commented 1 year ago

WARNING: 'myst' reference target not found: ../../user_guide/Widgets.ipynb

Isn't this one an actual error?

Other than that, it'd be great if you could add comments in nbsite/shared_conf.py about suppress_warnings to indicate why these warnings are suppressed (basically copying your original post). Noticed this kind of stuff tends to stick forever otherwise.

hoxbro commented 1 year ago

TBH, I just added it because I saw the warning a lot. I should have thought about it a bit more :upside_down_face:

I have downloaded the build docs step from this run (13_build docs.txt) and can see this warning is raised 147 times.

An example of a warning is 2023-04-09T15:47:29.8157231Z /home/runner/work/holoviews/holoviews/doc/gallery/demos/bokeh/dragon_curve.ipynb:10002: WARNING: 'myst' reference target not found: ../../topics/geometry/lsystems.ipynb and when looking in the notebook I can see the link here in the first cell:

Dragon curve example from the [L-systems](../../topics/geometry/lsystems.ipynb) topic notebook in ``examples/topics/geometry``.

So yes it seems to be a valid warning. I will remove it and add comments to the other two.