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

3.1.1: sphinx warnings #785

Closed
kloczek opened this issue Oct 27, 2021 · 1 comment · Fixed by #807
Closed

3.1.1: sphinx warnings #785

kloczek opened this issue Oct 27, 2021 · 1 comment · Fixed by #807

Comments

@kloczek
Copy link

kloczek commented Oct 27, 2021

Describe the bug
During generate documentation are emitted some warnings.
Here is command and output:

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.2.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] 61 added, 0 changed, 0 removed
reading sources... [100%] release_process
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/docs/contributing.rst:290: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/docs/contributing.rst:292: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth1/rfc5849/request_validator.py:docstring of oauthlib.oauth1.rfc5849.request_validator.RequestValidator.save_verifier:4: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth1/rfc5849/request_validator.py:docstring of oauthlib.oauth1.rfc5849.request_validator.RequestValidator.save_verifier:6: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/docs/oauth1/validator.rst:: WARNING: Anonymous hyperlink mismatch: 1 references but 0 targets.
See "backrefs" attribute for IDs.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/clients/base.py:docstring of oauthlib.oauth2.rfc6749.clients.base.Client.parse_request_body_response:11: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/clients/base.py:docstring of oauthlib.oauth2.rfc6749.clients.base.Client.prepare_authorization_request:10: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/clients/base.py:docstring of oauthlib.oauth2.rfc6749.clients.base.Client.prepare_authorization_request:17: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/clients/base.py:docstring of oauthlib.oauth2.rfc6749.clients.base.Client.prepare_authorization_request:22: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/clients/base.py:docstring of oauthlib.oauth2.rfc6749.clients.base.Client.prepare_refresh_token_request:16: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/clients/base.py:docstring of oauthlib.oauth2.rfc6749.clients.base.Client.prepare_token_request:10: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/clients/base.py:docstring of oauthlib.oauth2.rfc6749.clients.base.Client.prepare_token_request:15: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/clients/base.py:docstring of oauthlib.oauth2.rfc6749.clients.base.Client.prepare_token_revocation_request:8: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/clients/base.py:docstring of oauthlib.oauth2.rfc6749.clients.base.Client.prepare_token_revocation_request:14: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/endpoints/introspect.py:docstring of oauthlib.oauth2.rfc6749.endpoints.introspect.IntrospectEndpoint.validate_introspect_request:17: WARNING: Unexpected indentation.
WARNING: missing attribute finalize_id_token in object oauthlib.oauth2.RequestValidator
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/openid/connect/core/endpoints/userinfo.py:docstring of oauthlib.openid.connect.core.endpoints.userinfo.UserInfoEndpoint.validate_userinfo_request:28: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/docs/oauth2/oidc/validator.rst:8: WARNING: Title underline too short.

1. Create an OIDC provider
-----------------------
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/docs/oauth2/oidc/validator.rst:14: WARNING: Title underline too short.

2. Migrate your OAuth2.0 provider into an OIDC provider
----------------------------------------------------
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/docs/oauth2/oidc/validator.rst:14: WARNING: Title underline too short.

2. Migrate your OAuth2.0 provider into an OIDC provider
----------------------------------------------------
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/request_validator.py:docstring of oauthlib.oauth2.rfc6749.request_validator.RequestValidator:1: WARNING: duplicate object description of oauthlib.oauth2.RequestValidator, other instance in oauth2/oidc/id_tokens, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/request_validator.py:docstring of oauthlib.oauth2.rfc6749.request_validator.RequestValidator:1: WARNING: duplicate object description of oauthlib.oauth2.rfc6749.request_validator.RequestValidator, other instance in oauth2/oidc/id_tokens, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/request_validator.py:docstring of oauthlib.oauth2.rfc6749.request_validator.RequestValidator.validate_code:10: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/request_validator.py:docstring of oauthlib.oauth2.rfc6749.request_validator.RequestValidator.validate_code:18: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/oauthlib/oauth2/rfc6749/request_validator.py:docstring of oauthlib.oauth2.rfc6749.request_validator.RequestValidator.introspect_token:20: WARNING: Unknown target name: "_jwt claims".
/home/tkloczko/rpmbuild/BUILD/oauthlib-3.1.1/docs/release_process.rst:29: WARNING: Title underline too short.

How to get on the notifications list
-----------------------------------
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-oauthlib.3 { installation faq feature_matrix error_reporting contributing release_process oauth_1_versus_oauth_2 oauth1/oauth1 oauth1/client oauth1/server oauth1/validator oauth1/security oauth1/preconfigured_servers oauth1/endpoints/endpoints oauth1/endpoints/request_token oauth1/endpoints/authorization oauth1/endpoints/access_token oauth1/endpoints/resource oauth1/endpoints/signature_only oauth2/oauth2 oauth2/security oauth2/clients/client oauth2/clients/baseclient oauth2/clients/webapplicationclient oauth2/clients/mobileapplicationclient oauth2/clients/legacyapplicationclient oauth2/clients/backendapplicationclient oauth2/server oauth2/validator oauth2/preconfigured_servers oauth2/endpoints/endpoints oauth2/endpoints/authorization oauth2/endpoints/introspect oauth2/endpoints/token oauth2/endpoints/metadata oauth2/endpoints/revocation oauth2/endpoints/resource oauth2/grants/grants oauth2/grants/authcode oauth2/grants/implicit oauth2/grants/password oauth2/grants/credentials oauth2/grants/refresh oauth2/grants/jwt oauth2/grants/custom_validators oauth2/grants/custom_grant oauth2/tokens/tokens oauth2/tokens/bearer oauth2/tokens/saml oauth2/tokens/mac oauth2/oidc oauth2/oidc/validator oauth2/oidc/endpoints oauth2/oidc/userinfo oauth2/oidc/grants oauth2/oidc/dispatchers oauth2/oidc/authcode oauth2/oidc/implicit oauth2/oidc/hybrid oauth2/oidc/id_tokens } done
build succeeded, 27 warnings.
@auvipy
Copy link
Contributor

auvipy commented Oct 27, 2021

can you atleast fix some warning and come with a PR?

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

Successfully merging a pull request may close this issue.

3 participants