From bbbd30c6baf9d5e3e99642a7be0529cdbe2eef9b Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 4 Apr 2024 05:49:20 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=A1=20Toil=20the=20docs.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Suppress nitpicky checks for missing typeshed definitions. --- docs/conf.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 93eecfb5..2d792ef0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,6 +33,21 @@ # Be strict about any broken references nitpicky = True + +nitpick_ignore = [ + ('py:class', '_io.BufferedRandom'), + ('py:class', '_io.BufferedReader'), + ('py:class', '_io.BufferedWriter'), + ('py:class', '_io.FileIO'), + ('py:class', '_io.TextIOWrapper'), + ('py:class', 'Literal[-1, 1]'), + ('py:class', 'OpenBinaryMode'), + ('py:class', 'OpenBinaryModeReading'), + ('py:class', 'OpenBinaryModeUpdating'), + ('py:class', 'OpenBinaryModeWriting'), + ('py:class', 'OpenTextMode'), +] + # Include Python intersphinx mapping to prevent failures # jaraco/skeleton#51 extensions += ['sphinx.ext.intersphinx']