Open
Description
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/source build/sphinx/man
Running Sphinx v6.1.3
making output directory... done
myst v1.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'html_image'}, 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)
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 10 added, 0 changed, 0 removed
skipping non-JSON example generation.
skipping non-JSON example generation.
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-jupyterlab-server.3 { changelog api/index api/app-config api/app api/config api/handlers api/process api/rest api/spec } /home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/docs/source/api/app-config.rst:1209: WARNING: py:meth reference target not found: WebSocketHandler.get_compression_options
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/config.py:docstring of jupyterlab_server.config.get_static_page_config:1: WARNING: py:class reference target not found: logger
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/config.py:docstring of jupyterlab_server.config.get_static_page_config:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/config.py:docstring of jupyterlab_server.config.get_static_page_config:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/config.py:docstring of jupyterlab_server.config.get_static_page_config:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/config.py:docstring of jupyterlab_server.config.get_static_page_config:1: WARNING: py:class reference target not found: 'all'
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/handlers.py:docstring of jupyterlab_server.handlers.LabHandler:1: WARNING: py:class reference target not found: tornado.web.Application
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/handlers.py:docstring of jupyterlab_server.handlers.LabHandler:1: WARNING: py:class reference target not found: tornado.httputil.HTTPServerRequest
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/listings_handler.py:docstring of jupyterlab_server.listings_handler.ListingsHandler:1: WARNING: py:class reference target not found: tornado.web.Application
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/listings_handler.py:docstring of jupyterlab_server.listings_handler.ListingsHandler:1: WARNING: py:class reference target not found: tornado.httputil.HTTPServerRequest
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/settings_handler.py:docstring of jupyterlab_server.settings_handler.SettingsHandler:1: WARNING: py:class reference target not found: tornado.web.Application
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/settings_handler.py:docstring of jupyterlab_server.settings_handler.SettingsHandler:1: WARNING: py:class reference target not found: tornado.httputil.HTTPServerRequest
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/settings_handler.py:docstring of jupyterlab_server.settings_handler.SettingsHandler.get:1: WARNING: py:class reference target not found: ##
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/settings_utils.py:docstring of jupyterlab_server.settings_utils.get_settings:1: WARNING: py:class reference target not found: schema_name
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/settings_utils.py:docstring of jupyterlab_server.settings_utils.get_settings:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/settings_utils.py:docstring of jupyterlab_server.settings_utils.get_settings:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/settings_utils.py:docstring of jupyterlab_server.settings_utils.get_settings:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/themes_handler.py:docstring of jupyterlab_server.themes_handler.ThemesHandler:1: WARNING: py:class reference target not found: tornado.web.Application
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/themes_handler.py:docstring of jupyterlab_server.themes_handler.ThemesHandler:1: WARNING: py:class reference target not found: tornado.httputil.HTTPServerRequest
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/translations_handler.py:docstring of jupyterlab_server.translations_handler.TranslationsHandler:1: WARNING: py:class reference target not found: tornado.web.Application
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/translations_handler.py:docstring of jupyterlab_server.translations_handler.TranslationsHandler:1: WARNING: py:class reference target not found: tornado.httputil.HTTPServerRequest
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/translations_handler.py:docstring of jupyterlab_server.translations_handler.TranslationsHandler.get:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/workspaces_handler.py:docstring of jupyterlab_server.workspaces_handler.WorkspacesHandler:1: WARNING: py:class reference target not found: tornado.web.Application
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/workspaces_handler.py:docstring of jupyterlab_server.workspaces_handler.WorkspacesHandler:1: WARNING: py:class reference target not found: tornado.httputil.HTTPServerRequest
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/workspaces_handler.py:docstring of jupyterlab_server.workspaces_handler.WorkspacesHandler.initialize:1: WARNING: py:class reference target not found: jupyterlab_server.workspaces_handler.WorkspacesManager
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/process.py:docstring of jupyterlab_server.process.Process.wait:1: WARNING: py:class reference target not found: The process exit code.
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/process.py:docstring of jupyterlab_server.process.which:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/jupyterlab_server-2.22.0/jupyterlab_server/spec.py:docstring of jupyterlab_server.spec.get_openapi_spec:1: WARNING: py:class reference target not found: Spec
done
build succeeded, 28 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