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

8.1.2: sphinx warnings about missing refferesnces #86

Closed
kloczek opened this issue Apr 19, 2022 · 2 comments
Closed

8.1.2: sphinx warnings about missing refferesnces #86

kloczek opened this issue Apr 19, 2022 · 2 comments

Comments

@kloczek
Copy link

kloczek commented Apr 19, 2022

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

[tkloczko@devel-g2v elastic-transport-python-8.1.2]$ /usr/bin/sphinx-build -n -T -b man docs/sphinx build/sphinx/man
Running Sphinx v4.5.0
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
writing... python-elastic-transport.3 { installation nodes exceptions logging transport node_pool serializers client_utils } /home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.Urllib3HttpNode.perform_request:9: WARNING: py:class reference target not found: elastic_transport.HttpHeaders
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.Urllib3HttpNode.perform_request:: WARNING: py:class reference target not found: ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.RequestsHttpNode:3: WARNING: py:attr reference target not found: elastic_transport.NodeConfig._extras
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.RequestsHttpNode.perform_request:9: WARNING: py:class reference target not found: elastic_transport.HttpHeaders
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.RequestsHttpNode.perform_request:: WARNING: py:class reference target not found: ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.AiohttpHttpNode.perform_request:9: WARNING: py:class reference target not found: elastic_transport.HttpHeaders
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.AiohttpHttpNode.perform_request:: WARNING: py:class reference target not found: ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/docs/sphinx/logging.rst:11: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.Transport.perform_request:31: WARNING: py:class reference target not found: elastic_transport._transport.TransportApiResponse
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.Transport.perform_request:32: WARNING: py:class reference target not found: elastic_transport.ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.AsyncTransport.perform_request:31: WARNING: py:class reference target not found: elastic_transport._transport.TransportApiResponse
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.AsyncTransport.perform_request:32: WARNING: py:class reference target not found: elastic_transport.ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.NodePool:1: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.NodePool.get:8: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.NodePool.mark_dead:3: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.NodePool.mark_live:3: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.NodePool.resurrect:11: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.NodeSelector.select:3: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/__init__.py:docstring of elastic_transport.NodeSelector.select:7: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.1.2/elastic_transport/client_utils.py:docstring of elastic_transport.client_utils.resolve_default:: WARNING: py:class reference target not found: ~T
done
build succeeded, 20 warnings.

The manual pages are in build/sphinx/man.
@sethmlarson
Copy link
Contributor

Agree that these aren't critical issues, looking at the documentation built on RTD the mentioned references are working fine. Closing this.

@kloczek
Copy link
Author

kloczek commented Sep 22, 2022

Please check one more time. Those warnings are causeing that those warnings are causing that refferences are only highlited in html output but there is not actual links (I'm not affected by this issue because I'm interested only man page).

Here is list of current warnings

+ /usr/bin/sphinx-build -n -T -b man docs/sphinx build/sphinx/man
Running Sphinx v5.1.1
making output directory... done
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://docs.python-requests.org/en/master/objects.inv...
WARNING: failed to reach any of the inventories with the following issues:
intersphinx inventory 'https://docs.python-requests.org/en/master/objects.inv' not fetchable due to <class 'requests.exceptions.SSLError'>: HTTPSConnectionPool(host='docs.python-requests.org', port=443): Max retries exceeded with url: /en/master/objects.inv (Caused by SSLError(CertificateError("hostname 'docs.python-requests.org' doesn't match either of '*.ispapi.net', 'ispapi.net'")))
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%] transport
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-elastic-transport.3 { installation nodes exceptions logging transport node_pool serializers client_utils } /home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.Urllib3HttpNode.perform_request:9: WARNING: py:class reference target not found: elastic_transport.HttpHeaders
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.Urllib3HttpNode.perform_request:1: WARNING: py:class reference target not found: ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.RequestsHttpNode:3: WARNING: py:attr reference target not found: requests.Session.auth
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.RequestsHttpNode:3: WARNING: py:attr reference target not found: elastic_transport.NodeConfig._extras
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.RequestsHttpNode.perform_request:9: WARNING: py:class reference target not found: elastic_transport.HttpHeaders
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.RequestsHttpNode.perform_request:1: WARNING: py:class reference target not found: ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.AiohttpHttpNode.perform_request:9: WARNING: py:class reference target not found: elastic_transport.HttpHeaders
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.AiohttpHttpNode.perform_request:1: WARNING: py:class reference target not found: ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/docs/sphinx/logging.rst:11: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.Transport.perform_request:31: WARNING: py:class reference target not found: elastic_transport._transport.TransportApiResponse
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.Transport.perform_request:32: WARNING: py:class reference target not found: elastic_transport.ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.AsyncTransport.perform_request:31: WARNING: py:class reference target not found: elastic_transport._transport.TransportApiResponse
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.AsyncTransport.perform_request:32: WARNING: py:class reference target not found: elastic_transport.ApiResponseMeta
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.NodePool:1: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.NodePool.get:8: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.NodePool.mark_dead:3: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.NodePool.mark_live:3: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.NodePool.resurrect:11: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.NodeSelector.select:3: WARNING: py:class reference target not found: elastic_transport.BaseNode
/home/tkloczko/rpmbuild/BUILD/elastic-transport-python-8.4.0/elastic_transport/__init__.py:docstring of elastic_transport.NodeSelector.select:7: WARNING: py:class reference target not found: elastic_transport.BaseNode
done
build succeeded, 21 warnings.
On top is yet another warning which is not related to missing refferesnces.

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