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

0.5.3: sphinx warnings #156

Open
kloczek opened this issue Aug 16, 2021 · 1 comment
Open

0.5.3: sphinx warnings #156

kloczek opened this issue Aug 16, 2021 · 1 comment

Comments

@kloczek
Copy link

kloczek commented Aug 16, 2021

Looks like new sphinx 4.x shows some warnings

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.1.2
making output directory... done
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] 8 added, 0 changed, 0 removed
reading sources... [100%] reference/nbclient.tests
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-nbclient.3 { installation client changelog reference/index reference/nbclient reference/nbclient.tests reference/modules } /home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:5: WARNING: 'any' reference target not found: stop_on_error
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:5: WARNING: 'any' reference target not found: raises-exception
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:23: WARNING: 'any' reference target not found: language_info
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:26: WARNING: 'any' reference target not found: (async_)start_new_kernel_client
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:26: WARNING: 'any' reference target not found: (async_)start_new_kernel
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:26: WARNING: 'any' reference target not found: (async_)start_new_kernel_client
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:46: WARNING: 'any' reference target not found: reset_kc
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:50: WARNING: 'any' reference target not found: OSError: [WinError 6] The handle is invalid
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:70: WARNING: 'any' reference target not found: (async_)start_new_kernel_client
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:70: WARNING: 'any' reference target not found: self.km
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:70: WARNING: 'any' reference target not found: MultiKernelManager
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:70: WARNING: 'any' reference target not found: KernelManager
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:72: WARNING: 'any' reference target not found: reset_kc
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:72: WARNING: 'any' reference target not found: (async_)execute
/home/tkloczko/rpmbuild/BUILD/nbclient-0.5.3/docs/changelog.md:84: WARNING: 'any' reference target not found: async_
done
build succeeded, 15 warnings.
@kloczek
Copy link
Author

kloczek commented May 9, 2022

Additional batch of sphinx warnings about reference target not found
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
Updated cli docs
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
myst v0.17.2: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=[], linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, highlight_code_blocks=True, number_code_blocks=[], title_to_header=False, heading_anchors=None, heading_slug_func=None, footnote_transition=True, sub_delimiters=('{', '}'), words_per_minute=200)
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%] reference/nbclient.tests
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-nbclient.3 { installation client changelog reference/index reference/nbclient reference/nbclient.tests reference/config_options reference/modules } /home/tkloczko/rpmbuild/BUILD/nbclient-0.6.3/docs/client.rst:31: WARNING: py:class reference target not found: NotebookClient
/home/tkloczko/rpmbuild/BUILD/nbclient-0.6.3/docs/client.rst:72: WARNING: py:class reference target not found: NotebookClient
/usr/lib/python3.8/site-packages/nbclient/tests/base.py:docstring of nbclient.tests.base.NBClientTestsBase:1: WARNING: py:class reference target not found: unittest.case.TestCase
/usr/lib/python3.8/site-packages/nbclient/tests/fake_kernelmanager.py:docstring of nbclient.tests.fake_kernelmanager.FakeCustomKernelManager:1: WARNING: py:class reference target not found: jupyter_client.manager.AsyncKernelManager
/usr/lib/python3.8/site-packages/nbclient/tests/fake_kernelmanager.py:docstring of nbclient.tests.fake_kernelmanager.FakeCustomKernelManager.start_kernel:: WARNING: py:class reference target not found: optional
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient:1: WARNING: py:class reference target not found: traitlets.config.configurable.LoggingConfigurable
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.async_execute:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.async_execute:: WARNING: py:class reference target not found: NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.async_execute_cell:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.async_execute_cell:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.async_execute_cell:: WARNING: py:class reference target not found: nbformat.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.async_execute_cell:: WARNING: py:class reference target not found: NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.async_start_new_kernel_client:: WARNING: py:class reference target not found: jupyter_client.client.KernelClient
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.async_start_new_kernel_client:: WARNING: py:class reference target not found: KernelClient
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.async_wait_for_reply:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.create_kernel_manager:: WARNING: py:class reference target not found: jupyter_client.manager.KernelManager
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.create_kernel_manager:: WARNING: py:class reference target not found: KernelManager
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.util.run_sync.<locals>.wrapped:: WARNING: py:class reference target not found: NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.util.run_sync.<locals>.wrapped:: WARNING: py:class reference target not found: nbformat.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.util.run_sync.<locals>.wrapped:: WARNING: py:class reference target not found: NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.kernel_manager_class:: WARNING: py:class reference target not found: jupyter_client.manager.KernelManager
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.output:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.process_message:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.process_message:: WARNING: py:class reference target not found: nbformat.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.register_output_hook:: WARNING: py:class reference target not found: nbclient.output_widget.OutputWidget
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.NotebookClient.remove_output_hook:: WARNING: py:class reference target not found: nbclient.output_widget.OutputWidget
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.util.run_sync.<locals>.wrapped:: WARNING: py:class reference target not found: KernelClient
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.execute:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.execute:: WARNING: py:class reference target not found: jupyter_client.manager.KernelManager
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.execute:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.execute:: WARNING: py:class reference target not found: NotebookNode
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.execute:: WARNING: py:class reference target not found: optional
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.execute:: WARNING: py:class reference target not found: AsyncKernelManager
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.execute:: WARNING: py:class reference target not found: optional
/usr/lib/python3.8/site-packages/nbclient/client.py:docstring of nbclient.client.timestamp:: WARNING: py:class reference target not found: traitlets.traitlets.Dict
/usr/lib/python3.8/site-packages/nbclient/exceptions.py:docstring of nbclient.exceptions.CellExecutionError.from_cell_and_msg:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/usr/lib/python3.8/site-packages/nbclient/exceptions.py:docstring of nbclient.exceptions.CellTimeoutError.error_from_timeout_and_cell:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
done
build succeeded, 37 warnings.

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

1 participant