diff options
| author | Sviatoslav Sydorenko <wk@sydorenko.org.ua> | 2020-10-19 00:36:03 +0200 |
|---|---|---|
| committer | Sviatoslav Sydorenko <wk@sydorenko.org.ua> | 2020-10-19 00:36:03 +0200 |
| commit | 18b7a3e77aa81e9d22cd0a52061a2c8e3a640cc8 (patch) | |
| tree | b30c8969c6515342c080cad1aa1f8c3912a88c7a /docs | |
| parent | 8848933c2a6830b91461e356f4af3117813d96f7 (diff) | |
| download | python-setuptools-git-18b7a3e77aa81e9d22cd0a52061a2c8e3a640cc8.tar.gz | |
Allow some refs to undocumented/undeclared objects
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py index a0449699..de9fe3f8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -152,6 +152,42 @@ link_files = { # Be strict about any broken references: nitpicky = True +# Ref: https://stackoverflow.com/a/30624034/595220 +nitpick_ignore = [ + ('c:func', 'SHGetSpecialFolderPath'), # ref to MS docs + ('envvar', 'DISTUTILS_DEBUG'), # undocumented + ('envvar', 'HOME'), # undocumented + ('envvar', 'PLAT'), # undocumented + ('py:attr', 'CCompiler.language_map'), # undocumented + ('py:attr', 'CCompiler.language_order'), # undocumented + ('py:class', 'distutils.dist.Distribution'), # undocumented + ('py:class', 'distutils.extension.Extension'), # undocumented + ('py:class', 'BorlandCCompiler'), # undocumented + ('py:class', 'CCompiler'), # undocumented + ('py:class', 'CygwinCCompiler'), # undocumented + ('py:class', 'distutils.dist.DistributionMetadata'), # undocumented + ('py:class', 'FileList'), # undocumented + ('py:class', 'IShellLink'), # ref to MS docs + ('py:class', 'MSVCCompiler'), # undocumented + ('py:class', 'OptionDummy'), # undocumented + ('py:class', 'UnixCCompiler'), # undocumented + ('py:exc', 'CompileError'), # undocumented + ('py:exc', 'DistutilsExecError'), # undocumented + ('py:exc', 'DistutilsFileError'), # undocumented + ('py:exc', 'LibError'), # undocumented + ('py:exc', 'LinkError'), # undocumented + ('py:exc', 'PreprocessError'), # undocumented + ('py:func', 'distutils.CCompiler.new_compiler'), # undocumented + # undocumented: + ('py:func', 'distutils.dist.DistributionMetadata.read_pkg_file'), + ('py:func', 'distutils.file_util._copy_file_contents'), # undocumented + ('py:func', 'distutils.log.debug'), # undocumented + ('py:func', 'distutils.spawn.find_executable'), # undocumented + ('py:func', 'distutils.spawn.spawn'), # undocumented + # TODO: check https://docutils.rtfd.io in the future + ('py:mod', 'docutils'), # there's no Sphinx site documenting this +] + # Ref: https://github.com/python-attrs/attrs/pull/571/files\ # #diff-85987f48f1258d9ee486e3191495582dR82 |