From d7329c44f76c173eb8a4b6f053821ba9cfcbc878 Mon Sep 17 00:00:00 2001
From: Leszek Hanusz <leszek.hanusz@gmail.com>
Date: Thu, 12 Dec 2024 01:44:57 +0100
Subject: [PATCH] Adding nitpick_ignore for currently unfixable references

---
 docs/conf.py | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/docs/conf.py b/docs/conf.py
index c537ce94..94daf942 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -89,3 +89,41 @@
     'websockets': ('https://websockets.readthedocs.io/en/11.0.3/', None),
     'yarl': ('https://yarl.readthedocs.io/en/stable/', None),
 }
+
+nitpick_ignore = [
+    # graphql-core: should be fixed
+    ('py:class', 'graphql.execution.execute.ExecutionResult'),
+    ('py:class', 'Source'),
+    ('py:class', 'GraphQLSchema'),
+
+    # asyncio: should be fixed
+    ('py:class', 'asyncio.locks.Event'),
+
+    # aiohttp: should be fixed
+    ('py:class', 'aiohttp.client_reqrep.Fingerprint'),
+    ('py:class', 'aiohttp.helpers.BasicAuth'),
+
+    # multidict: should be fixed
+    ('py:class', 'multidict._multidict.CIMultiDictProxy'),
+    ('py:class', 'multidict._multidict.CIMultiDict'),
+    ('py:class', 'multidict._multidict.istr'),
+
+    # websockets: first bump websockets version
+    ('py:class', 'websockets.datastructures.SupportsKeysAndGetItem'),
+    ('py:class', 'websockets.typing.Subprotocol'),
+
+    # httpx: no sphinx docs yet https://github.com/encode/httpx/discussions/3091
+    ('py:class', 'httpx.AsyncClient'),
+    ('py:class', 'httpx.Client'),
+    ('py:class', 'httpx.Headers'),
+
+    # botocore: no sphinx docs
+    ('py:class', 'botocore.auth.BaseSigner'),
+    ('py:class', 'botocore.awsrequest.AWSRequest'),
+    ('py:class', 'botocore.credentials.Credentials'),
+    ('py:class', 'botocore.session.Session'),
+
+    # gql: ignore private classes
+    ('py:class', 'gql.transport.httpx._HTTPXTransport'),
+    ('py:class', 'gql.client._CallableT'),
+]