Is there a way to suppress warnings but only for a given directory in Sphinx

51 views
Skip to first unread message

Menelik Weatherspoon

unread,
Aug 30, 2024, 6:11:18 PM8/30/24
to sphinx-users

I am generating API documentation using autoapi.extension in Sphinx. It is a large repo, and not all of the doc strings are well formatted and this generates a lot of sphinx docutils warnings. However I also want sphinx to fail on warnings for the rst files that are manually written. The autogenerated api gets written to a specific directory, so I was wondering if there was a way to ignore warnings just in that specific section

Currently I am suppressing all docutil warnings with the suppressed_warnings in the conf.py. Fixing all of the doc strings in the repo is not really an option, as this is a large repo with a lot of people contributing.


This email message, including any attachments, contains or may contain sensitive, proprietary, and confidential information intended only for the addressee. Not for further distribution without the express written consent of Vast Space, LLC. If you are not an intended recipient of this message, be advised that any reading, dissemination, forwarding, printing, copying, or other use of this message or its attachments is strictly prohibited. Moreover, this email may contain technical data or technology as defined in the International Traffic in Arms Regulations (ITAR) or the Export Administration Regulations (EAR) and export, re-export, or transfer of this information to a third party or foreign entity requires the prior approval of Vast and the U.S. Government.
Reply all
Reply to author
Forward
0 new messages