Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sphinx warnings reference target not found #19

Open
kloczek opened this issue Feb 18, 2024 · 2 comments
Open

sphinx warnings reference target not found #19

kloczek opened this issue Feb 18, 2024 · 2 comments

Comments

@kloczek
Copy link

kloczek commented Feb 18, 2024

First of all currently it is not possible to use straight sphinx-build command to build documentation out of source tree

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v7.1.2

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 356, in eval_config_file
    exec(code, namespace)  # NoQA: S102
  File "/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/docs/conf.py", line 1, in <module>
    from joserfc import __version__
ModuleNotFoundError: No module named 'joserfc'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/cmd/build.py", line 285, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 207, in __init__
    self.config = Config.read(self.confdir, confoverrides or {}, self.tags)
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 179, in read
    namespace = eval_config_file(filename, tags)
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 369, in eval_config_file
    raise ConfigError(msg % traceback.format_exc()) from exc
sphinx.errors.ConfigError: There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 356, in eval_config_file
    exec(code, namespace)  # NoQA: S102
  File "/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/docs/conf.py", line 1, in <module>
    from joserfc import __version__
ModuleNotFoundError: No module named 'joserfc'

This can be fixed by patch like below:

--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,3 +1,7 @@
+import sys
+import os
+sys.path.insert(0, os.path.abspath("../src"))
+
 from joserfc import __version__

 project = "joserfc"

This patch fixes what is in the comment and that can of fix is suggested in sphinx example copy.py https://www.sphinx-doc.org/en/master/usage/configuration.html#example-of-configuration-file

Than .. on building my packages I'm using sphinx-build command with -n switch which shows warmings about missing references. These are not critical issues.

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v7.1.2
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 28 added, 0 changed, 0 removed
reading sources... [100%] stability
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... joserfc.1 { guide/introduction install guide/index guide/jwk guide/jwt guide/jws guide/jwe guide/algorithms guide/registry migrations/index migrations/authlib migrations/pyjwt recipes/azure recipes/openssl api/index api/jws api/jwe api/jwk api/jwt security stability contributing/index contributing/structure contributing/translation contributing/authors contributing/sponsors changelog } /home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/docs/guide/jws.rst:168: WARNING: py:class reference target not found: jwk.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/docs/guide/algorithms.rst:216: WARNING: py:class reference target not found: joserfc.jwk.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7515/registry.py:docstring of joserfc.rfc7515.registry.JWSRegistry:1: WARNING: py:class reference target not found: joserfc.registry.HeaderParameter
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.deserialize_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.deserialize_compact:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.deserialize_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.deserialize_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.deserialize_json:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.deserialize_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.deserialize_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.deserialize_json:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.deserialize_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.detach_content:1: WARNING: py:class reference target not found: joserfc.jws.DetachValue
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.detach_content:1: WARNING: py:class reference target not found: joserfc.jws.DetachValue
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.serialize_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.serialize_compact:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.serialize_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.serialize_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.serialize_json:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.serialize_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.serialize_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.serialize_json:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.serialize_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.validate_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.validate_compact:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jws.py:docstring of joserfc.jws.validate_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7516/registry.py:docstring of joserfc.rfc7516.registry.JWERegistry:1: WARNING: py:class reference target not found: joserfc.registry.HeaderParameter
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7516/registry.py:docstring of joserfc.rfc7516.registry.JWERegistry.get_alg:1: WARNING: py:class reference target not found: joserfc.rfc7516.models.JWEKeyEncryption
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7516/registry.py:docstring of joserfc.rfc7516.registry.JWERegistry.get_alg:1: WARNING: py:class reference target not found: joserfc.rfc7516.models.JWEKeyWrapping
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7516/registry.py:docstring of joserfc.rfc7516.registry.JWERegistry.get_alg:1: WARNING: py:class reference target not found: joserfc.rfc7516.models.JWEKeyAgreement
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7516/registry.py:docstring of joserfc.rfc7516.registry.JWERegistry.get_alg:1: WARNING: py:class reference target not found: joserfc.rfc7516.models.JWEDirectEncryption
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7516/registry.py:docstring of joserfc.rfc7516.registry.JWERegistry.get_enc:1: WARNING: py:class reference target not found: joserfc.rfc7516.models.JWEEncModel
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7516/registry.py:docstring of joserfc.rfc7516.registry.JWERegistry.get_zip:1: WARNING: py:class reference target not found: joserfc.rfc7516.models.JWEZipModel
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7516/models.py:docstring of joserfc.rfc7516.models.Recipient:1: WARNING: py:class reference target not found: joserfc.rfc7516.models.KeyType
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_compact:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_json:1: WARNING: py:class reference target not found: joserfc.rfc7516.types.GeneralJSONSerialization
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_json:1: WARNING: py:class reference target not found: joserfc.rfc7516.types.FlattenedJSONSerialization
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_json:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.decrypt_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_compact:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_compact:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc.rfc7516.types.GeneralJSONSerialization
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwe.py:docstring of joserfc.jwe.encrypt_json:1: WARNING: py:class reference target not found: joserfc.rfc7516.types.FlattenedJSONSerialization
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/ec_key.py:docstring of joserfc.rfc7518.ec_key.ECKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.models.NativePrivateKey
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/ec_key.py:docstring of joserfc.rfc7518.ec_key.ECKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.models.NativePublicKey
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/ec_key.py:docstring of joserfc.rfc7518.ec_key.ECKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/ec_key.py:docstring of joserfc.rfc7518.ec_key.ECKey.generate_key:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/ec_key.py:docstring of joserfc.jwk.ECKey.value_registry:1: WARNING: py:class reference target not found: joserfc.registry.KeyParameter
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/_keys.py:docstring of joserfc._keys.JWKRegistry.generate_key:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/_keys.py:docstring of joserfc._keys.JWKRegistry.import_key:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc8037/okp_key.py:docstring of joserfc.rfc8037.okp_key.OKPKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.models.NativePrivateKey
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc8037/okp_key.py:docstring of joserfc.rfc8037.okp_key.OKPKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.models.NativePublicKey
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc8037/okp_key.py:docstring of joserfc.rfc8037.okp_key.OKPKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc8037/okp_key.py:docstring of joserfc.rfc8037.okp_key.OKPKey.generate_key:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc8037/okp_key.py:docstring of joserfc.jwk.OKPKey.value_registry:1: WARNING: py:class reference target not found: joserfc.registry.KeyParameter
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/oct_key.py:docstring of joserfc.rfc7518.oct_key.OctKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.models.NativePrivateKey
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/oct_key.py:docstring of joserfc.rfc7518.oct_key.OctKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.models.NativePublicKey
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/oct_key.py:docstring of joserfc.rfc7518.oct_key.OctKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/oct_key.py:docstring of joserfc.rfc7518.oct_key.OctKey.generate_key:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/oct_key.py:docstring of joserfc.jwk.OctKey.value_registry:1: WARNING: py:class reference target not found: joserfc.registry.KeyParameter
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/rsa_key.py:docstring of joserfc.rfc7518.rsa_key.RSAKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.models.NativePrivateKey
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/rsa_key.py:docstring of joserfc.rfc7518.rsa_key.RSAKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.models.NativePublicKey
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/rsa_key.py:docstring of joserfc.rfc7518.rsa_key.RSAKey:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/rsa_key.py:docstring of joserfc.rfc7518.rsa_key.RSAKey.generate_key:1: WARNING: py:class reference target not found: joserfc.rfc7517.types.KeyParameters
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/rfc7518/rsa_key.py:docstring of joserfc.jwk.RSAKey.value_registry:1: WARNING: py:class reference target not found: joserfc.registry.KeyParameter
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwk.py:docstring of joserfc.jwk.guess_key:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwk.py:docstring of joserfc.jwk.guess_key:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwk.py:docstring of joserfc.jwk.guess_key:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwk.py:docstring of joserfc.jwk.guess_key:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwt.py:docstring of joserfc.jwt.decode:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwt.py:docstring of joserfc.jwt.decode:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwt.py:docstring of joserfc.jwt.decode:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwt.py:docstring of joserfc.jwt.encode:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwt.py:docstring of joserfc.jwt.encode:1: WARNING: py:class reference target not found: joserfc.jwk.GuestProtocol
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/src/joserfc/jwt.py:docstring of joserfc.jwt.encode:1: WARNING: py:class reference target not found: joserfc._keys.KeySet
/home/tkloczko/rpmbuild/BUILD/joserfc-0.9.0/docs/changelog.rst:39: WARNING: py:class reference target not found: jwk.KeySet
done
build succeeded, 91 warnings.

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

@lepture
Copy link
Member

lepture commented Jun 4, 2024

You need to install the project at first.

@kloczek
Copy link
Author

kloczek commented Jun 4, 2024

You need to install the project at first.

Patch which I've posted removes that step and guarantees that documentation will be generated out of the code will be generated out of the source tree .. only.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants