How to suppress the various warnings at build time

[DKilkenny]

Hello,

I am currently buildings some docs that don't all need to be in the _toc.yml and I'm trying to figure out how to suppress all the different warnings such as:

• WARNING: document isn't included in any toctree
• Document or section may not begin with a transition
• WARNING: Found a content page that is not in _toc.yml
• WARNING: Unexpected section title.

These are warnings that I'm ok with ignoring and just want to hide them so I can find other issues easier. I have tried adding to the suppress_warnings but to no avail.

sphinx:
  config:
    suppress_warnings:
      - myst.domains
      - nbsphinx
      - autodoc
      - autodoc.import_object
  extra_extensions:
  - 'sphinx.ext.autodoc'
  - 'sphinx.ext.autosummary'

[chrisjsewell]

Heya,

You can use

only_build_toc_files: true

in your _config.yml

@choldgraf I don't see this mentioned in https://jupyterbook.org/customize/toc.html

[choldgraf]

good point - we should document that 👍

though, it is weird that the warnings are still happening even with the config above, no?

[chrisjsewell]

No, none of the warnings are related to those suppressed

[DKilkenny]

Thanks for the reply!

Further documentation on TOC customization would be super helpful 👍🏻. I tried adding that to my config and it cut down on the amount of WARNING: document isn't included in any toctree but it didn't fully eliminate them. Also, still getting a number of WARNING: Document or section may not begin with a transition.. Thoughts on this?

[DKilkenny]

Also I understand that yml setting only builds the files in the toc but it would great to allow all the files to be built while suppressing the warnings.

[chrisjsewell]

I would check the document, that the title is correctly underlined; there's not a new line after the text or something