1.4.6: sphinx warnings `reference target not found`

[kloczek]

trafficstars

On building my packages I'm using sphinx-build command with -n switch which shows warmings about missing references. These are not critical issues. Here is the output with warnings:

+ /usr/bin/sphinx-build -n -T -b man aiosmtpd/docs build/sphinx/man
Running Sphinx v7.3.7
Inserting /home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6
Inserting /home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/_exts
Inserting /home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 14 added, 0 changed, 0 removed
reading sources... [100%] testing
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-aiosmtpd.3 { intro concepts cli controller smtp lmtp handlers auth proxyprotocol migrating testing manpage NEWS } /home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/concepts.rst:49: WARNING: py:class reference target not found: SMTP
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/concepts.rst:91: WARNING: py:attr reference target not found: auth_callback
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/concepts.rst:100: WARNING: py:attr reference target not found: authenticator
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/controller.rst:227: WARNING: py:class reference target not found: UnthreadedController
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/controller.rst:227: WARNING: py:class reference target not found: Controller
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/controller.rst:228: WARNING: py:class reference target not found: UnixSocketUnthreadedController
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/controller.rst:228: WARNING: py:class reference target not found: UnixSocketController
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/controller.rst:294: WARNING: py:meth reference target not found: end
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/controller.rst:449: WARNING: py:meth reference target not found: _create_server
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/controller.rst:469: WARNING: py:attr reference target not found: **SMTP_Parameters
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/controller.rst:520: WARNING: py:attr reference target not found: server_hostname
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/controller.rst:581: WARNING: py:attr reference target not found: smtpd
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/smtp.rst:294: WARNING: py:class reference target not found: aiosmtpd.smtp.AuthenticatorType
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/smtp.rst:377: WARNING: py:meth reference target not found: asyncio.new_event_loop
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/smtp.rst:495: WARNING: py:class reference target not found: _Missing
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/handlers.rst:40: WARNING: py:class reference target not found: SMTP
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/handlers.rst:174: WARNING: py:attr reference target not found: envelope.mail_from
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/handlers.rst:174: WARNING: py:attr reference target not found: envelope.mail_options
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/handlers.rst:190: WARNING: py:class reference target not found: SMTP
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/handlers.rst:274: WARNING: py:func reference target not found: handle_message
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/handlers.rst:314: WARNING: py:func reference target not found: prepare_message
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/handlers.rst:314: WARNING: py:func reference target not found: handle_message
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/handlers.rst:321: WARNING: py:func reference target not found: prepare_message
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/handlers.rst:321: WARNING: py:func reference target not found: handle_message()`
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:13: WARNING: py:attr reference target not found: authenticator
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:45: WARNING: py:meth reference target not found: SMTP.push
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:45: WARNING: py:meth reference target not found: SMTP.challenge_auth
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:94: WARNING: py:class reference target not found: SMTP
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:101: WARNING: py:attr reference target not found: authenticator
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:113: WARNING: py:attr reference target not found: auth_exclude_mechanism
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:113: WARNING: py:class reference target not found: SMTP
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:167: WARNING: py:meth reference target not found: smtp_AUTH
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:182: WARNING: py:meth reference target not found: smtp_AUTH
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:189: WARNING: py:meth reference target not found: smtp_AUTH
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:192: WARNING: py:meth reference target not found: smtp_AUTH
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/auth.rst:201: WARNING: py:class reference target not found: LoginPassword
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:39: WARNING: py:attr reference target not found: proxy_protocol_timeout
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:64: WARNING: py:attr reference target not found: handler
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:73: WARNING: py:class reference target not found: SMTP
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:90: WARNING: py:attr reference target not found: proxy_data
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:164: WARNING: py:attr reference target not found: AF.UNIX
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:171: WARNING: py:attr reference target not found: PROTO.DGRAM
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:173: WARNING: py:class reference target not found: IPv4Address
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:173: WARNING: py:class reference target not found: IPv6Address
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:181: WARNING: py:class reference target not found: IPv4Address
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:181: WARNING: py:class reference target not found: IPv6Address
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:195: WARNING: py:attr reference target not found: AF.INET
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:195: WARNING: py:attr reference target not found: AF.INET6
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:203: WARNING: py:attr reference target not found: AF.INET
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:203: WARNING: py:attr reference target not found: AF.INET6
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:219: WARNING: py:attr reference target not found: AF.INET
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:219: WARNING: py:attr reference target not found: AF.INET6
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:219: WARNING: py:attr reference target not found: AF.UNIX
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:265: WARNING: py:attr reference target not found: error
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:435: WARNING: py:attr reference target not found: whole_raw
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:435: WARNING: py:attr reference target not found: tlv_start
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/proxyprotocol.rst:435: WARNING: py:attr reference target not found: tlv_loc
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/migrating.rst:7: WARNING: py:mod reference target not found: smtpd
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/migrating.rst:10: WARNING: py:class reference target not found: smtpd.SMTPServer
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/migrating.rst:54: WARNING: py:meth reference target not found: smtpd.SMTPServer.process_message
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/migrating.rst:58: WARNING: py:meth reference target not found: Controller.start
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/migrating.rst:58: WARNING: py:meth reference target not found: Controller.stop
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/testing.rst:61: WARNING: py:class reference target not found: ExposingController
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/testing.rst:65: WARNING: py:class reference target not found: Controller
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/testing.rst:72: WARNING: py:class reference target not found: Sink
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/testing.rst:116: WARNING: py:class reference target not found: HostPort
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/NEWS.rst:86: WARNING: py:class reference target not found: UnixSocketController
/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.6/aiosmtpd/docs/NEWS.rst:178: WARNING: py:class reference target not found: SMTP
done
build succeeded, 68 warnings.

You can peak on fixes that kind of issues in other projects https://github.com/RDFLib/rdflib-sqlalchemy/issues/95 https://github.com/RDFLib/rdflib/pull/2036 https://github.com/click-contrib/sphinx-click/commit/abc31069 https://github.com/frostming/unearth/issues/14 https://github.com/jaraco/cssutils/issues/21 https://github.com/latchset/jwcrypto/pull/289 https://github.com/latchset/jwcrypto/pull/289 https://github.com/pypa/distlib/commit/98b9b89f https://github.com/pywbem/pywbem/pull/2895 https://github.com/sissaschool/elementpath/commit/bf869d9e https://github.com/sissaschool/xmlschema/commit/42ea98f2 https://github.com/sqlalchemy/sqlalchemy/commit/5e88e6e8