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.

Sign up for GitHub

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

Jump to bottom

21.5.0: sphinx warnings reference target not found #420

Closed
kloczek opened this issue May 20, 2022 · 11 comments
Closed

21.5.0: sphinx warnings reference target not found #420

kloczek opened this issue May 20, 2022 · 11 comments

Comments

@kloczek
Copy link

kloczek commented May 20, 2022

First of all currently it is not possible to use straight sphinx-build command to build documentation out of source tree

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v4.5.0

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 332, in eval_config_file
    exec(code, namespace)
  File "/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/docs/conf.py", line 43, in <module>
    release = metadata.version("structlog")
  File "/usr/lib64/python3.8/importlib/metadata.py", line 530, in version
    return distribution(distribution_name).version
  File "/usr/lib64/python3.8/importlib/metadata.py", line 503, in distribution
    return Distribution.from_name(distribution_name)
  File "/usr/lib64/python3.8/importlib/metadata.py", line 177, in from_name
    raise PackageNotFoundError(name)
importlib.metadata.PackageNotFoundError: structlog

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/cmd/build.py", line 272, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 202, in __init__
    self.config = Config.read(self.confdir, confoverrides or {}, self.tags)
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 165, in read
    namespace = eval_config_file(filename, tags)
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 345, in eval_config_file
    raise ConfigError(msg % traceback.format_exc()) from exc
sphinx.errors.ConfigError: There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 332, in eval_config_file
    exec(code, namespace)
  File "/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/docs/conf.py", line 43, in <module>
    release = metadata.version("structlog")
  File "/usr/lib64/python3.8/importlib/metadata.py", line 530, in version
    return distribution(distribution_name).version
  File "/usr/lib64/python3.8/importlib/metadata.py", line 503, in distribution
    return Distribution.from_name(distribution_name)
  File "/usr/lib64/python3.8/importlib/metadata.py", line 177, in from_name
    raise PackageNotFoundError(name)
importlib.metadata.PackageNotFoundError: structlog


Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 332, in eval_config_file
    exec(code, namespace)
  File "/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/docs/conf.py", line 43, in <module>
    release = metadata.version("structlog")
  File "/usr/lib64/python3.8/importlib/metadata.py", line 530, in version
    return distribution(distribution_name).version
  File "/usr/lib64/python3.8/importlib/metadata.py", line 503, in distribution
    return Distribution.from_name(distribution_name)
  File "/usr/lib64/python3.8/importlib/metadata.py", line 177, in from_name
    raise PackageNotFoundError(name)
importlib.metadata.PackageNotFoundError: structlog

This can be fixed by patch like below:

--- a/docs/conf.py~     2022-05-20 10:06:46.107190599 +0000
+++ b/docs/conf.py      2022-05-20 10:12:32.737264031 +0000
@@ -3,13 +3,15 @@
 # 2.0, and the MIT License.  See the LICENSE file in the root of this
 # repository for complete details.

-from importlib import metadata
+import sys
+import os
+sys.path.insert(0, os.path.abspath('../src'))

+import structlog

 # We want an image in the README and include the README in the docs.
 suppress_warnings = ["image.nonlocal_uri"]

-
 # -- General configuration ----------------------------------------------------

 extensions = [
@@ -40,7 +42,7 @@
 # built documents.

 # The full version, including alpha/beta/rc tags.
-release = metadata.version("structlog")
+release = structlog.__version__
 # The short X.Y version.
 version = release.rsplit(".", 1)[0]

This patch fixes what is in the comment and that can of fix is suggested in sphinx example copy.py https://www.sphinx-doc.org/en/master/usage/configuration.html#example-of-configuration-file
That patch as well removes importlib module from build dependencies and obtains curent structlog version straight from module.

Than .. 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
loading intersphinx inventory from 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] 20 added, 0 changed, 0 removed
reading sources... [100%] why
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-structlog.3 { why getting-started loggers configuration testing thread-local contextvars processors examples development types standard-library twisted logging-best-practices custom-wrappers performance api license changelog } /home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/docs/api.rst:: WARNING: py:class reference target not found: WrappedLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/docs/api.rst:: WARNING: py:class reference target not found: Processor
/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/docs/api.rst:: WARNING: py:class reference target not found: Context
done
build succeeded, 3 warnings.

You can peak on fixes that kind of issues in other projects
latchset/jwcrypto#289
click-contrib/sphinx-click@abc31069
@kloczek
Copy link
Author

kloczek commented May 20, 2022

Please let me know if you want that patch as PR.

@kloczek
Copy link
Author

kloczek commented May 20, 2022

Updated warnings against current master

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
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)
loading intersphinx inventory from 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] 20 added, 0 changed, 0 removed
reading sources... [100%] why
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-structlog.3 { why getting-started loggers configuration testing contextvars processors examples development types standard-library twisted logging-best-practices custom-wrappers performance thread-local api license changelog } /home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/src/structlog/_loggers.py:docstring of structlog._loggers.PrintLogger:: WARNING: py:class reference target not found: TextIO
/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/src/structlog/_loggers.py:docstring of structlog._loggers.PrintLoggerFactory:: WARNING: py:class reference target not found: TextIO
/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/src/structlog/_loggers.py:docstring of structlog._loggers.WriteLogger:: WARNING: py:class reference target not found: TextIO
/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/src/structlog/_loggers.py:docstring of structlog._loggers.WriteLoggerFactory:: WARNING: py:class reference target not found: TextIO
/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/src/structlog/_loggers.py:docstring of structlog._loggers.BytesLogger:: WARNING: py:class reference target not found: BinaryIO
/home/tkloczko/rpmbuild/BUILD/structlog-21.5.0/src/structlog/_loggers.py:docstring of structlog._loggers.BytesLoggerFactory:: WARNING: py:class reference target not found: BinaryIO
done
build succeeded, 6 warnings.

@kloczek
Copy link
Author

kloczek commented Jul 20, 2022

Tested 21.1.0 with sphinx 5.0.2 there are much more warnings

writing... python-structlog.3 { why getting-started loggers configuration testing thread-local contextvars processors examples development types standard-library twisted logging-best-practices custom-wrappers performance api backward-compatibility contributing license changelog } /home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/getting-started.rst:34: WARNING: 'any' reference target not found: structlog.dev.ConsoleRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/getting-started.rst:62: WARNING: 'any' reference target not found: structlog.processors.KeyValueRenderer()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/getting-started.rst:64: WARNING: 'any' reference target not found: structlog.make_filtering_bound_logger()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/getting-started.rst:64: WARNING: 'any' reference target not found: FilteringBoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/getting-started.rst:154: WARNING: py:class reference target not found: structlog.processors.JSONRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/getting-started.rst:183: WARNING: py:func reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/getting-started.rst:194: WARNING: py:class reference target not found: structlog.processors.JSONRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:8: WARNING: py:class reference target not found: structlog.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:21: WARNING: py:func reference target not found: structlog.BoundLogger.bind
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:21: WARNING: py:func reference target not found: structlog.BoundLogger.new
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:22: WARNING: py:func reference target not found: structlog.BoundLogger.unbind
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:26: WARNING: py:class reference target not found: structlog.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:44: WARNING: 'any' reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:48: WARNING: 'any' reference target not found: structlog.wrap_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:92: WARNING: py:class reference target not found: structlog.processors.StackInfoRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:92: WARNING: py:func reference target not found: structlog.processors.format_exc_info
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:92: WARNING: py:class reference target not found: structlog.processors.TimeStamper
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:92: WARNING: py:class reference target not found: structlog.dev.ConsoleRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/loggers.rst:103: WARNING: py:class reference target not found: structlog.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:8: WARNING: py:func reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:18: WARNING: py:func reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:47: WARNING: py:class reference target not found: structlog.PrintLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:49: WARNING: py:func reference target not found: structlog.wrap_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:62: WARNING: py:func reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:66: WARNING: py:func reference target not found: structlog.wrap_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:68: WARNING: py:func reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:71: WARNING: py:func reference target not found: structlog.reset_defaults
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:91: WARNING: 'any' reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:94: WARNING: py:func reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:107: WARNING: 'any' reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:114: WARNING: 'any' reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:116: WARNING: py:class reference target not found: structlog.stdlib.LoggerFactory
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:124: WARNING: 'any' reference target not found: structlog.stdlib.LoggerFactory
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:125: WARNING: 'any' reference target not found: structlog.twisted.LoggerFactory
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:136: WARNING: 'any' reference target not found: structlog.stdlib.LoggerFactory
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:145: WARNING: 'any' reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:145: WARNING: 'any' reference target not found: structlog.PrintLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:169: WARNING: 'any' reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:169: WARNING: 'any' reference target not found: structlog.configure_once
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:169: WARNING: 'any' reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/configuration.rst:169: WARNING: py:func reference target not found: structlog.configure_once
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/testing.rst:6: WARNING: 'any' reference target not found: structlog.testing.capture_logs
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/testing.rst:24: WARNING: 'any' reference target not found: structlog.testing.LogCapture
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/testing.rst:43: WARNING: 'any' reference target not found: structlog.testing.CapturingLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/testing.rst:43: WARNING: 'any' reference target not found: CapturingLoggerFactory
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/testing.rst:62: WARNING: 'any' reference target not found: structlog.testing.ReturnLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:30: WARNING: 'any' reference target not found: structlog.threadlocal
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:41: WARNING: 'any' reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:41: WARNING: 'any' reference target not found: structlog.threadlocal.merge_threadlocal
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:42: WARNING: 'any' reference target not found: structlog.threadlocal.clear_threadlocal
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:43: WARNING: 'any' reference target not found: structlog.threadlocal.bind_threadlocal
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:44: WARNING: 'any' reference target not found: structlog.threadlocal.merge_threadlocal
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:82: WARNING: 'any' reference target not found: merge_threadlocal
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:88: WARNING: 'any' reference target not found: structlog.threadlocal.wrap_dict
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:116: WARNING: 'any' reference target not found: structlog.threadlocal.wrap_dict
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:131: WARNING: 'any' reference target not found: structlog.threadlocal
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:131: WARNING: 'any' reference target not found: structlog.threadlocal.tmp_bind
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:154: WARNING: 'any' reference target not found: structlog.threadlocal.as_immutable
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:163: WARNING: py:func reference target not found: structlog.BoundLogger.new
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/thread-local.rst:163: WARNING: py:func reference target not found: structlog.BoundLogger.bind
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/contextvars.rst:18: WARNING: 'any' reference target not found: structlog.contextvars
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/contextvars.rst:23: WARNING: 'any' reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/contextvars.rst:23: WARNING: 'any' reference target not found: structlog.contextvars.merge_contextvars
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/contextvars.rst:24: WARNING: 'any' reference target not found: structlog.contextvars.clear_contextvars
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/contextvars.rst:25: WARNING: 'any' reference target not found: structlog.contextvars.bind_contextvars
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/contextvars.rst:25: WARNING: 'any' reference target not found: structlog.contextvars.unbind_contextvars
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/contextvars.rst:26: WARNING: 'any' reference target not found: structlog.contextvars.merge_contextvars
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/processors.rst:65: WARNING: 'any' reference target not found: TimeStamper
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/processors.rst:71: WARNING: 'any' reference target not found: structlog.DropEvent
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/processors.rst:88: WARNING: 'any' reference target not found: structlog.make_filtering_bound_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/processors.rst:119: WARNING: 'any' reference target not found: structlog.processors.JSONRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/examples.rst:79: WARNING: 'any' reference target not found: structlog.threadlocal.clear_threadlocal()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/examples.rst:80: WARNING: 'any' reference target not found: structlog.threadlocal.bind_threadlocal()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/examples.rst:81: WARNING: 'any' reference target not found: structlog.threadlocal.merge_threadlocal()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/examples.rst:88: WARNING: 'any' reference target not found: structlog.stdlib.LoggerFactory
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/examples.rst:88: WARNING: 'any' reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/examples.rst:88: WARNING: 'any' reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/examples.rst:114: WARNING: py:class reference target not found: structlog.twisted.EventAdapter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/development.rst:4: WARNING: 'any' reference target not found: structlog.dev
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/development.rst:6: WARNING: 'any' reference target not found: structlog.dev.ConsoleRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/development.rst:14: WARNING: 'any' reference target not found: ConsoleRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/types.rst:22: WARNING: 'any' reference target not found: structlog.get_logger()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/types.rst:22: WARNING: 'any' reference target not found: structlog.types.BindableLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/types.rst:22: WARNING: 'any' reference target not found: structlog.get_logger()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/types.rst:28: WARNING: 'any' reference target not found: structlog.stdlib.get_logger()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/types.rst:28: WARNING: 'any' reference target not found: structlog.get_logger()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/types.rst:28: WARNING: 'any' reference target not found: structlog.stdlib.BoundLogger.bind
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/types.rst:30: WARNING: 'any' reference target not found: structlog.get_logger()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:4: WARNING: 'any' reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:36: WARNING: 'any' reference target not found: structlog.stdlib.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:36: WARNING: 'any' reference target not found: structlog.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:46: WARNING: 'any' reference target not found: structlog.stdlib.get_logger()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:46: WARNING: 'any' reference target not found: structlog.stdlib.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:46: WARNING: 'any' reference target not found: structlog.get_logger()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:54: WARNING: 'any' reference target not found: structlog.stdlib.AsyncBoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:59: WARNING: 'any' reference target not found: AsyncBoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:69: WARNING: 'any' reference target not found: render_to_log_kwargs
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:74: WARNING: 'any' reference target not found: filter_by_level
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:77: WARNING: 'any' reference target not found: add_logger_name
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:80: WARNING: py:func reference target not found: structlog.stdlib.add_log_level
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:92: WARNING: 'any' reference target not found: add_log_level_number
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:96: WARNING: 'any' reference target not found: PositionalArgumentsFormatter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:98: WARNING: 'any' reference target not found: ProcessorFormatter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:162: WARNING: 'any' reference target not found: ProcessorFormatter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:164: WARNING: 'any' reference target not found: ProcessorFormatter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:166: WARNING: 'any' reference target not found: structlog.stdlib.ProcessorFormatter.wrap_for_formatter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:166: WARNING: 'any' reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:168: WARNING: 'any' reference target not found: ProcessorFormatter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:207: WARNING: 'any' reference target not found: ProcessorFormatter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:207: WARNING: 'any' reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:309: WARNING: py:func reference target not found: structlog.stdlib.add_log_level
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:327: WARNING: 'any' reference target not found: ProcessorFormatter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:358: WARNING: 'any' reference target not found: UnicodeDecoder
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/standard-library.rst:358: WARNING: 'any' reference target not found: UnicodeEncoder
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:16: WARNING: 'any' reference target not found: structlog.twisted.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:16: WARNING: 'any' reference target not found: structlog.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:20: WARNING: py:func reference target not found: structlog.twisted.BoundLogger.msg
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:20: WARNING: py:func reference target not found: structlog.twisted.BoundLogger.err
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:23: WARNING: 'any' reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:23: WARNING: 'any' reference target not found: structlog.getLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:50: WARNING: 'any' reference target not found: structlog.twisted.EventAdapter
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:55: WARNING: 'any' reference target not found: structlog.twisted.JSONRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:60: WARNING: 'any' reference target not found: structlog.twisted.JSONLogObserverWrapper
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:62: WARNING: 'any' reference target not found: structlog.twisted.JSONRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:75: WARNING: 'any' reference target not found: structlog.twisted.PlainFileLogObserver
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:75: WARNING: 'any' reference target not found: structlog.twisted.plainJSONStdOutLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/twisted.rst:75: WARNING: 'any' reference target not found: structlog.twisted.JSONLogObserverWrapper
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/logging-best-practices.rst:40: WARNING: 'any' reference target not found: TimeStamper
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/custom-wrappers.rst:17: WARNING: 'any' reference target not found: structlog.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/custom-wrappers.rst:20: WARNING: 'any' reference target not found: structlog.BoundLogger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/custom-wrappers.rst:23: WARNING: 'any' reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/custom-wrappers.rst:23: WARNING: 'any' reference target not found: structlog.BoundLoggerBase
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/custom-wrappers.rst:53: WARNING: 'any' reference target not found: structlog.BoundLoggerBase._logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/custom-wrappers.rst:54: WARNING: 'any' reference target not found: structlog.BoundLoggerBase._proxy_to_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/custom-wrappers.rst:54: WARNING: 'any' reference target not found: DropEvent
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/custom-wrappers.rst:54: WARNING: 'any' reference target not found: _logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/custom-wrappers.rst:55: WARNING: 'any' reference target not found: structlog.BoundLoggerBase._process_event
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/performance.rst:14: WARNING: 'any' reference target not found: structlog.make_filtering_bound_logger()
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/performance.rst:20: WARNING: py:func reference target not found: structlog.wrap_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/performance.rst:20: WARNING: py:func reference target not found: structlog.get_logger
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/performance.rst:36: WARNING: py:func reference target not found: structlog.configure
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/performance.rst:38: WARNING: 'any' reference target not found: structlog.PrintLoggerFactory
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/performance.rst:38: WARNING: 'any' reference target not found: structlog.BytesLoggerFactory
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/performance.rst:79: WARNING: 'any' reference target not found: BytesLoggerFactory
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/api.rst:7: WARNING: 'any' reference target not found: structlog.processors.KeyValueRenderer
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/api.rst:68: WARNING: 'any' reference target not found: structlog.dev
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/api.rst:79: WARNING: 'any' reference target not found: structlog.testing
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/api.rst:107: WARNING: 'any' reference target not found: structlog.threadlocal
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/api.rst:136: WARNING: 'any' reference target not found: structlog.contextvars
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/api.rst:149: WARNING: 'any' reference target not found: structlog.processors
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/api.rst:230: WARNING: 'any' reference target not found: structlog.stdlib
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/api.rst:261: WARNING: 'any' reference target not found: structlog.types
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/api.rst:286: WARNING: 'any' reference target not found: structlog.twisted
/home/tkloczko/rpmbuild/BUILD/structlog-21.1.0/docs/backward-compatibility.rst:14: WARNING: py:mod reference target not found: structlog.dev
done

@kloczek
Copy link
Author

kloczek commented Jul 20, 2022

You can peak on fixes that kind of issues in other projects
latchset/jwcrypto#289
click-contrib/sphinx-click@abc31069
latchset/jwcrypto#289
RDFLib/rdflib-sqlalchemy#95
sissaschool/elementpath@bf869d9e
jaraco/cssutils#21
pywbem/pywbem#2895
sissaschool/xmlschema@42ea98f2
RDFLib/rdflib#2036
frostming/unearth#14

@hynek
Copy link
Owner

hynek commented Jul 21, 2022

As I've told you at this point at least once: for me building the docs without installing the package is a non-goal and I'm not certain these work-arounds haven't other, unexpected side-effects that might bite me down the road.

Please install the package into the build environment or find other workarounds (maybe PYTHONPATH or whatever). I don't want to be rude, but I'm closing these issues now without further discussion.

@hynek hynek closed this as completed Jul 21, 2022
@kloczek
Copy link
Author

kloczek commented Jul 21, 2022

As I've told you at this point at least once: for me building the docs without installing the package is a non-goal and I'm not certain these work-arounds haven't other, unexpected side-effects that might bite me down the road.

Those wartnings have nothing to do with fact module code is installed or not.
Please try at least use sphinx with -n option.

@hynek
Copy link
Owner

hynek commented Jul 22, 2022

structlog/tox.ini

Lines 29 to 30 in f123768

sphinx-build -n -T -W -b html -d {envtmpdir}/doctrees docs docs/_build/html
sphinx-build -n -T -W -b doctest -d {envtmpdir}/doctrees docs docs/_build/html

structlog/docs/Makefile

Lines 44 to 45 in f123768

html:
$(SPHINXBUILD) -n -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

@kloczek
Copy link
Author

kloczek commented Jul 22, 2022

Could you please check which one version of the sphinx is downoling tox?

@hynek
Copy link
Owner

hynek commented Jul 22, 2022

https://github.com/hynek/structlog/runs/7428467795?check_suite_focus=true#step:5:153

the currently latest: 5.0.2

@kloczek
Copy link
Author

kloczek commented May 20, 2023

Sphinx 5.x is no longer supported.
In mean time 6.x and 7.x have been released.
Do you have any plans to update structlog for sphinx >= 6.x?
Also sphinxcontrib-mermaid is not ready for sphinx >= 6.x mgaitan/sphinxcontrib-mermaid#122

@hynek
Copy link
Owner

hynek commented May 22, 2023

structlog's docs build fine on Sphinx 6 and is stuck on it for now due to a pin in MyST.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hynek @kloczek