ipykernel icon indicating copy to clipboard operation
ipykernel copied to clipboard

6.0.2: sphinx 4.0.3 warnings

Open kloczek opened this issue 4 years ago • 1 comments

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.0.3
Initializing GitHub plugin
making output directory... done
myst v0.15.1: MdParserConfig(renderer='sphinx', commonmark_only=False, enable_extensions=['dollarmath'], 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=[], url_schemes=['http', 'https', 'mailto', 'ftp'], heading_anchors=None, heading_slug_func=None, html_meta=[], footnote_transition=True, substitutions=[], sub_delimiters=['{', '}'], words_per_minute=200)
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://ipython.readthedocs.io/en/latest/objects.inv...
loading intersphinx inventory from https://jupyter.readthedocs.io/en/latest/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index
/home/tkloczko/rpmbuild/BUILD/ipykernel-6.0.2/docs/index.rst:11: WARNING: toctree contains reference to nonexisting document 'changelog'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-ipykernel.3 { } done
build succeeded, 1 warning.

kloczek avatar Jul 15 '21 13:07 kloczek

With 6.25.2 I see much more warnings.

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v7.0.1
Initializing GitHub plugin
making output directory... done
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, 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', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://ipython.readthedocs.io/en/latest/objects.inv...
loading intersphinx inventory from https://jupyter.readthedocs.io/en/latest/objects.inv...
intersphinx inventory has moved: https://jupyter.readthedocs.io/en/latest/objects.inv -> https://docs.jupyter.org/en/latest/objects.inv
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 5 added, 0 changed, 0 removed
reading sources... [ 20%] api/ipykernel
reading sources... [ 40%] api/ipykernel.comm
reading sources... [ 60%] api/ipykernel.inprocess
reading sources... [ 80%] api/modules
reading sources... [100%] index

WARNING: autodoc: failed to import module 'trio_runner' from module 'ipykernel'; the following exception was raised:
No module named 'trio'
/home/tkloczko/rpmbuild/BUILD/ipykernel-6.25.2/docs/index.rst:11: WARNING: toctree contains reference to nonexisting document 'changelog'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-ipykernel.3 { api/modules api/ipykernel api/ipykernel.comm api/ipykernel.inprocess } /usr/lib/python3.8/site-packages/ipykernel/comm/comm.py:docstring of ipykernel.comm.comm.Comm:1: WARNING: py:class reference target not found: ipykernel.comm.comm.BaseComm
/usr/lib/python3.8/site-packages/ipykernel/comm/comm.py:docstring of ipykernel.comm.comm.Comm:1: WARNING: py:class reference target not found: traitlets.config.configurable.LoggingConfigurable
/usr/lib/python3.8/site-packages/ipykernel/comm/manager.py:docstring of ipykernel.comm.manager.CommManager:1: WARNING: py:class reference target not found: comm.base_comm.CommManager
/usr/lib/python3.8/site-packages/ipykernel/comm/manager.py:docstring of ipykernel.comm.manager.CommManager:1: WARNING: py:class reference target not found: traitlets.config.configurable.LoggingConfigurable
/usr/lib/python3.8/site-packages/ipykernel/comm/comm.py:docstring of ipykernel.comm.comm.Comm:1: WARNING: py:class reference target not found: ipykernel.comm.comm.BaseComm
/usr/lib/python3.8/site-packages/ipykernel/comm/comm.py:docstring of ipykernel.comm.comm.Comm:1: WARNING: py:class reference target not found: traitlets.config.configurable.LoggingConfigurable
/usr/lib/python3.8/site-packages/ipykernel/comm/manager.py:docstring of ipykernel.comm.manager.CommManager:1: WARNING: py:class reference target not found: comm.base_comm.CommManager
/usr/lib/python3.8/site-packages/ipykernel/comm/manager.py:docstring of ipykernel.comm.manager.CommManager:1: WARNING: py:class reference target not found: traitlets.config.configurable.LoggingConfigurable
/usr/lib/python3.8/site-packages/ipykernel/inprocess/client.py:docstring of ipykernel.inprocess.client.InProcessKernelClient:1: WARNING: py:class reference target not found: jupyter_client.client.KernelClient
/usr/lib/python3.8/site-packages/ipykernel/inprocess/manager.py:docstring of ipykernel.inprocess.manager.InProcessKernelManager:1: WARNING: py:class reference target not found: jupyter_client.manager.KernelManager
<unknown>:1: WARNING: py:class reference target not found: traitlets.traitlets.DottedObjectName
/usr/lib/python3.8/site-packages/ipykernel/inprocess/socket.py:docstring of ipykernel.inprocess.socket.DummySocket:1: WARNING: py:class reference target not found: traitlets.traitlets.HasTraits
/usr/lib/python3.8/site-packages/ipykernel/displayhook.py:docstring of ipykernel.displayhook.ZMQShellDisplayHook:1: WARNING: py:class reference target not found: IPython.core.displayhook.DisplayHook
/usr/lib/python3.8/site-packages/ipykernel/kernelapp.py:docstring of ipykernel.kernelapp.IPKernelApp:1: WARNING: py:class reference target not found: jupyter_client.connect.ConnectionFileMixin
<unknown>:1: WARNING: py:class reference target not found: zmq.sugar.context.Context
/usr/lib/python3.8/site-packages/ipykernel/kernelbase.py:docstring of ipykernel.kernelbase.Kernel:1: WARNING: py:class reference target not found: traitlets.config.configurable.SingletonConfigurable
<unknown>:1: WARNING: py:class reference target not found: psutil.Process
/usr/lib/python3.8/site-packages/ipykernel/kernelbase.py:docstring of ipykernel.kernelbase.Kernel.send_response:3: WARNING: py:meth reference target not found: jupyter_client.session.Session.send
/usr/lib/python3.8/site-packages/ipykernel/kernelspec.py:docstring of ipykernel.kernelspec.InstallIPythonKernelSpecApp:1: WARNING: py:class reference target not found: traitlets.config.application.Application
<unknown>:1: WARNING: py:class reference target not found: traitlets.traitlets.Unicode
/usr/lib/python3.8/site-packages/ipykernel/log.py:docstring of ipykernel.log.EnginePUBHandler:1: WARNING: py:class reference target not found: zmq.log.handlers.PUBHandler
<unknown>:1: WARNING: py:class reference target not found: zmq.sugar.context.Context
<unknown>:1: WARNING: py:class reference target not found: zmq.sugar.socket.Socket
/usr/lib/python3.8/site-packages/ipykernel/zmqshell.py:docstring of ipykernel.zmqshell.ZMQDisplayPublisher:1: WARNING: py:class reference target not found: IPython.core.displaypub.DisplayPublisher
done
build succeeded, 26 warnings.

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

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

kloczek avatar Sep 04 '23 17:09 kloczek