diff --git a/docs/conf.py b/docs/conf.py index ed9ee753..1075b1aa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,21 +4,6 @@ import globus_sdk -# running `tox -e docs -- -n` will pick up "nitpick" warning which we convert to build -# errors with `-W` -# load ignores from file -nitpick_ignore = [] -nitpick_ignore_regex = [] -with open("nitpick_ignore.txt") as fp: - for line in fp: - line = line.strip() - if line == "" or line.startswith("#"): - continue - if line.startswith("re: "): - nitpick_ignore_regex.append(tuple(line.split()[1:])) - else: - nitpick_ignore.append(tuple(line.split())) - intersphinx_mapping = { "python": ("https://docs.python.org/3", None), } diff --git a/docs/nitpick_ignore.txt b/docs/nitpick_ignore.txt deleted file mode 100644 index 17316c85..00000000 --- a/docs/nitpick_ignore.txt +++ /dev/null @@ -1,35 +0,0 @@ -# define nitpick ignores in a file with the following rules: -# lines starting with '#' and empty lines are ignored -# lines are split and added to nitpick_ignore -# lines starting with 're: ' are split and added to nitpick_ignore_regex - -# standard ways of writing type information (e.g. 'Optional[str]' -> 'str, optional') -py:class optional -py:class callable -py:class class - -# True/False as class because they appear in Literal type annotations -py:class True -py:class False - -# nitpick can fail on stdlib modules, skip these... -py:class uuid.UUID -py:class UUID -py:class abc.ABC -py:class datetime.datetime -py:class datetime - -# inheritance can break cross-references in inherited signatures, so ignore these -# SDK classes -# see: https://github.com/sphinx-doc/sphinx/issues/6211 -py:class GlobusHTTPResponse - -# "list of ...", "sequence of ..." -re: py:class (sequence|iterable|list|tuple)\sof\s\w+ -# type vars in SDK modules -re: py:class globus_sdk\..*\.(T|RT) - -# cryptography and requests types -py:class RSAPublicKey -re: py:class cryptography\..* -re: py:class requests\..*