0.18.0: sphinx warnings `reference target not found`

[kloczek]

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:

```console + /usr/bin/sphinx-build -n -T -b man docs/source build/sphinx/man Running Sphinx v5.0.2 making output directory... done WARNING: html_static_path entry '_static' does not exist loading intersphinx inventory from https://docs.python.org/objects.inv... intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv building [mo]: targets for 0 po files that are out of date building [man]: all manpages updating environment: [new config] 18 added, 0 changed, 0 removed reading sources... [100%] quickstart /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/eddsa.py:docstring of ecdsa.eddsa.bytes_to_int:9: WARNING: Inline interpreted text or phrase reference start-string without end-string. /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/ellipticcurve.py:docstring of ecdsa.ellipticcurve.bytes_to_int:9: WARNING: Inline interpreted text or phrase reference start-string without end-string. looking for now-outdated files... none found pickling environment... done checking consistency... done writing... python-ecdsa.1 { quickstart basics ec_arithmetic glossary modules ecdsa ecdsa.curves ecdsa.der ecdsa.ecdh ecdsa.ecdsa ecdsa.eddsa ecdsa.ellipticcurve ecdsa.errors ecdsa.keys ecdsa.numbertheory ecdsa.rfc6979 ecdsa.util } /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/der.py:docstring of ecdsa.der.encode_bitstring:: WARNING: py:class reference target not found: bytes like object /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/der.py:docstring of ecdsa.der.remove_bitstring:: WARNING: py:class reference target not found: bytes like object /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/ecdh.py:docstring of ecdsa.ecdh.ECDH.load_private_key_der:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/ecdh.py:docstring of ecdsa.ecdh.ECDH.load_private_key_pem:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/ecdh.py:docstring of ecdsa.ecdh.ECDH.load_received_public_key_der:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/ecdh.py:docstring of ecdsa.ecdh.ECDH.load_received_public_key_pem:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey:5: WARNING: py:class reference target not found: hashlib.sha1 /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.from_secret_exponent:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.from_string:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.generate:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.generate:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign:17: WARNING: py:attr reference target not found: VerifyingKey.default_hashfunc /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign:17: WARNING: py:func reference target not found: hashlib.sha1 /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign:: WARNING: py:class reference target not found: sigencode function dependent type /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_deterministic:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_deterministic:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_deterministic:: WARNING: py:class reference target not found: sigencode function dependent type /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_digest:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_digest:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_digest:: WARNING: py:class reference target not found: sigencode function dependent type /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_digest_deterministic:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_digest_deterministic:11: WARNING: py:attr reference target not found: VerifyingKey.default_hashfunc /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_digest_deterministic:11: WARNING: py:func reference target not found: hashlib.sha1 /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_digest_deterministic:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_digest_deterministic:: WARNING: py:class reference target not found: sigencode function dependent type /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_number:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.SigningKey.sign_number:: WARNING: py:class reference target not found: tuple of ints /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_der:: WARNING: py:class reference target not found: bytes-like object /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_key_recovery:: WARNING: py:class reference target not found: bytes-like object /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_key_recovery:: WARNING: py:class reference target not found: bytes-like object /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_key_recovery:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_key_recovery:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_key_recovery:: WARNING: py:class reference target not found: list of VerifyingKey /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_key_recovery_with_digest:: WARNING: py:class reference target not found: bytes-like object /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_key_recovery_with_digest:: WARNING: py:class reference target not found: bytes-like object /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_key_recovery_with_digest:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_key_recovery_with_digest:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_point:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_public_point:10: WARNING: py:class reference target not found: hashlib.sha1 /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.from_string:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.verify:: WARNING: py:class reference target not found: sigdecode method dependent /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.verify:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.verify:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.verify_digest:: WARNING: py:class reference target not found: sigdecode method dependent /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/keys.py:docstring of ecdsa.keys.VerifyingKey.verify_digest:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/rfc6979.py:docstring of ecdsa.rfc6979.generate_k:5: WARNING: py:class reference target not found: hashlib.sha1 /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/util.py:docstring of ecdsa.util.sigdecode_der:: WARNING: py:class reference target not found: bytes like object /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/util.py:docstring of ecdsa.util.sigdecode_der:: WARNING: py:class reference target not found: tuple of ints /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/util.py:docstring of ecdsa.util.sigdecode_string:: WARNING: py:class reference target not found: bytes like object /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/util.py:docstring of ecdsa.util.sigdecode_string:: WARNING: py:class reference target not found: tuple of ints /home/tkloczko/rpmbuild/BUILD/python-ecdsa-python-ecdsa-0.18.0/src/ecdsa/util.py:docstring of ecdsa.util.sigdecode_strings:: WARNING: py:class reference target not found: tuple of ints done build succeeded, 58 warnings. ```

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

[tomato42]

Yes, documentation is still very much an "in-progress" kind of thing. Closing as duplicate of #95