python-jose icon indicating copy to clipboard operation
python-jose copied to clipboard

3.3.0: sphinx warnings `reference target not found`

Open kloczek opened this issue 3 years ago • 0 comments

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 docs build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 9 added, 0 changed, 0 removed
reading sources... [100%] jwt/index
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.decode:47: WARNING: Definition list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-jose.3 { jws/index jwt/index jwk/index jwe/index jws/api jwt/api jwk/api jwe/api } /home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jws.py:docstring of jose.jws.get_unverified_claims:: WARNING: py:exc reference target not found: JWSError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jws.py:docstring of jose.jws.get_unverified_header:: WARNING: py:exc reference target not found: JWSError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jws.py:docstring of jose.jws.get_unverified_headers:: WARNING: py:exc reference target not found: JWSError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jws.py:docstring of jose.jws.sign:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jws.py:docstring of jose.jws.sign:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jws.py:docstring of jose.jws.sign:: WARNING: py:exc reference target not found: JWSError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jws.py:docstring of jose.jws.verify:: WARNING: py:exc reference target not found: JWSError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.decode:: WARNING: py:class reference target not found: iterable
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.decode:: WARNING: py:exc reference target not found: JWTError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.decode:: WARNING: py:exc reference target not found: ExpiredSignatureError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.decode:: WARNING: py:exc reference target not found: JWTClaimsError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.encode:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.encode:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.encode:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.encode:: WARNING: py:exc reference target not found: JWTError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.get_unverified_claims:: WARNING: py:exc reference target not found: JWTError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.get_unverified_header:: WARNING: py:exc reference target not found: JWTError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwt.py:docstring of jose.jwt.get_unverified_headers:: WARNING: py:exc reference target not found: JWTError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwe.py:docstring of jose.jwe.decrypt:: WARNING: py:exc reference target not found: JWEError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwe.py:docstring of jose.jwe.encrypt:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwe.py:docstring of jose.jwe.encrypt:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwe.py:docstring of jose.jwe.encrypt:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwe.py:docstring of jose.jwe.encrypt:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwe.py:docstring of jose.jwe.encrypt:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwe.py:docstring of jose.jwe.encrypt:: WARNING: py:exc reference target not found: JWEError
/home/tkloczko/rpmbuild/BUILD/python-jose-3.3.0/docs/../jose/jwe.py:docstring of jose.jwe.get_unverified_header:: WARNING: py:exc reference target not found: JWEError
done
build succeeded, 28 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

kloczek avatar May 29 '22 13:05 kloczek