search

falconry / falcon

The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.
https://falcon.readthedocs.io/en/stable/
Apache License 2.0
9.51k stars 937 forks source link

3.1.0: sphinx warnings `reference target not found` #2079

Closed kloczek closed 2 years ago

kloczek commented 2 years ago

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

```console + /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man Running Sphinx v5.0.2 Traceback (most recent call last): File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 343, in eval_config_file exec(code, namespace) File "/home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/conf.py", line 26, in import falcon ModuleNotFoundError: No module named 'falcon' 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 356, 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 343, in eval_config_file exec(code, namespace) File "/home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/conf.py", line 26, in import falcon ModuleNotFoundError: No module named 'falcon' 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 343, in eval_config_file exec(code, namespace) File "/home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/conf.py", line 26, in import falcon ModuleNotFoundError: No module named 'falcon' ```

This can be fixed by patch like below:

--- a/docs/conf.py
+++ b/docs/conf.py
@@ -18,6 +18,8 @@
 import sys
 import os

+sys.path.insert(0, os.path.abspath(".."))
+
 try:
     import configparser
 except ImportError:

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

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:

```console + /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man Running Sphinx v5.0.2 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] 54 added, 0 changed, 0 removed reading sources... [100%] user/tutorial-asgi looking for now-outdated files... none found pickling environment... done checking consistency... done writing... python-falcon.3 { user/index user/intro user/install user/quickstart user/tutorial user/tutorial-asgi user/recipes/index user/recipes/header-name-case user/recipes/multipart-mixed user/recipes/output-csv user/recipes/pretty-json user/recipes/raw-url-path user/recipes/request-id user/faq deploy/index deploy/intro deploy/nginx-uwsgi community/index community/help community/contribute api/index api/app api/request_and_response api/request_and_response_wsgi api/request_and_response_asgi api/websocket api/cookies api/status api/errors api/media api/multipart api/redirects api/middleware api/cors api/hooks api/routing api/inspect api/util api/testing changes/index changes/3.1.0 changes/3.0.1 changes/3.0.0 changes/2.0.0 changes/1.4.1 changes/1.4.0 changes/1.3.0 changes/1.2.0 changes/1.1.0 changes/1.0.0 changes/0.3.0 changes/0.2.0 } /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/app.py:docstring of falcon.app.App.add_error_handler:: WARNING: py:class reference target not found: iterable of types /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/app.py:docstring of falcon.app.App.add_error_handler:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/app.py:docstring of falcon.app.App.add_route:: WARNING: py:class reference target not found: instance /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/app.py:docstring of falcon.app.App.add_sink:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/app.py:docstring of falcon.app.App.set_error_serializer:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/app.py:docstring of falcon.asgi.app.App:161: WARNING: py:class reference target not found: .CORSMiddleware /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/app.py:docstring of falcon.asgi.app.App.add_error_handler:: WARNING: py:class reference target not found: iterable of types /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/app.py:docstring of falcon.asgi.app.App.add_route:: WARNING: py:class reference target not found: instance /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/app.py:docstring of falcon.asgi.app.App.add_sink:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.RequestOptions:92: WARNING: py:attr reference target not found: falcon.DEFAULT_MEDIA_TYPE /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/response.py:docstring of falcon.response.ResponseOptions:19: WARNING: py:attr reference target not found: falcon.DEFAULT_MEDIA_TYPE /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request:55: WARNING: py:class reference target not found: class /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request:330: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request:511: WARNING: py:class reference target not found: tuple of int /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request:553: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request:560: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request.client_prefers:: WARNING: py:class reference target not found: iterable of str /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request.get_header_as_datetime:: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request.get_header_as_datetime:: WARNING: py:exc reference target not found: HttpInvalidHeader /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request.get_media:: WARNING: py:class reference target not found: media /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/request.py:docstring of falcon.request.Request.get_param_as_uuid:: WARNING: py:class reference target not found: UUID /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/response.py:docstring of falcon.response.Response:117: WARNING: py:class reference target not found: class /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/response.py:docstring of falcon.response.Response.append_link:: WARNING: py:obj reference target not found: tuple of str /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/response.py:docstring of falcon.response.Response.append_link:: WARNING: py:obj reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.asgi.request.Request:: WARNING: py:class reference target not found: awaitable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.asgi.request.Request:61: WARNING: py:class reference target not found: class /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.asgi.request.Request:337: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.asgi.request.Request:456: WARNING: py:class reference target not found: tuple of int /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.asgi.request.Request:498: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.asgi.request.Request:505: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.request.Request.client_prefers:: WARNING: py:class reference target not found: iterable of str /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.request.Request.get_header_as_datetime:: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.request.Request.get_header_as_datetime:: WARNING: py:exc reference target not found: HttpInvalidHeader /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.asgi.request.Request.get_media:: WARNING: py:class reference target not found: media /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/request.py:docstring of falcon.request.Request.get_param_as_uuid:: WARNING: py:class reference target not found: UUID /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/stream.py:docstring of falcon.asgi.stream.BoundedStream:: WARNING: py:class reference target not found: awaitable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/response.py:docstring of falcon.asgi.response.Response:155: WARNING: py:class reference target not found: coroutine /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/response.py:docstring of falcon.asgi.response.Response:192: WARNING: py:class reference target not found: class /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/response.py:docstring of falcon.response.Response.append_link:: WARNING: py:obj reference target not found: tuple of str /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/response.py:docstring of falcon.response.Response.append_link:: WARNING: py:obj reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/response.py:docstring of falcon.asgi.response.Response.schedule_sync:6: WARNING: py:meth reference target not found: asyncio.AbstractEventLoop.set_default_executor /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/response.py:docstring of falcon.asgi.response.Response.schedule_sync:27: WARNING: py:meth reference target not found: asyncio.AbstractEventLoop.set_default_executor /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/ws.py:docstring of falcon.asgi.ws.WebSocket:: WARNING: py:class reference target not found: falcon.constants.WebSocketPayloadType /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/ws.py:docstring of falcon.asgi.ws.WebSocket.send_media:: WARNING: py:class reference target not found: falcon.constants.WebSocketPayloadType /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/asgi/ws.py:docstring of falcon.asgi.ws.WebSocket.send_media:: WARNING: py:obj reference target not found: falcon.WebSocketPayloadType /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/media/json.py:docstring of falcon.media.json.JSONHandlerWS:: WARNING: py:obj reference target not found: func /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/media/json.py:docstring of falcon.media.json.JSONHandlerWS:: WARNING: py:obj reference target not found: func /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/errors.py:docstring of falcon.errors.HTTPUnauthorized:: WARNING: py:obj reference target not found: iterable of str /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/errors.py:docstring of falcon.errors.HTTPMethodNotAllowed:: WARNING: py:class reference target not found: list of str /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/api/media.rst:136: WARNING: py:meth reference target not found: Request.get_media /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/api/media.rst:148: WARNING: py:meth reference target not found: Request.get_media /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/api/media.rst:148: WARNING: py:attr reference target not found: Request.media /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/media/json.py:docstring of falcon.media.json.JSONHandler:: WARNING: py:obj reference target not found: func /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/media/json.py:docstring of falcon.media.json.JSONHandler:: WARNING: py:obj reference target not found: func /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/media/msgpack.py:docstring of falcon.media.msgpack.MessagePackHandler:1: WARNING: py:mod reference target not found: msgpack /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/hooks.py:docstring of falcon.hooks.before:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/hooks.py:docstring of falcon.hooks.after:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/api/routing.rst:316: WARNING: py:attr reference target not found: CompiledRouterOptions.converters /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/routing/compiled.py:docstring of falcon.routing.compiled.CompiledRouter.map_http_methods:: WARNING: py:class reference target not found: instance /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/routing/util.py:docstring of falcon.routing.util.compile_uri_template:7: WARNING: py:meth reference target not found: re.MatchObject.groupdict /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/app_helpers.py:docstring of falcon.app_helpers.prepare_middleware:: WARNING: py:class reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/app_helpers.py:docstring of falcon.app_helpers.prepare_middleware_ws:: WARNING: py:class reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/inspect.py:docstring of falcon.inspect.AppInfo.to_string:: WARNING: py:class reference target not found: optional /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/inspect.py:docstring of falcon.inspect.AppInfo.to_string:: WARNING: py:class reference target not found: optional /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/inspect.py:docstring of falcon.inspect.AppInfo.to_string:: WARNING: py:class reference target not found: optional /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/inspect.py:docstring of falcon.inspect.ErrorHandlerInfo:: WARNING: py:class reference target not found: name /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/inspect.py:docstring of falcon.inspect.InspectVisitor.process:: WARNING: py:class reference target not found: falcon.inspect._Traversable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/inspect.py:docstring of falcon.inspect.InspectVisitor.process:: WARNING: py:class reference target not found: _Traversable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/inspect.py:docstring of falcon.inspect.StringVisitor:: WARNING: py:class reference target not found: optional /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/inspect.py:docstring of falcon.inspect.StringVisitor:: WARNING: py:class reference target not found: optional /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/inspect.py:docstring of falcon.inspect.StringVisitor:: WARNING: py:class reference target not found: optional /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/misc.py:docstring of falcon.util.misc.dt_to_http:: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/misc.py:docstring of falcon.util.misc.http_date_to_dt:: WARNING: py:class reference target not found: datetime /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/sync.py:docstring of falcon.util.sync.sync_to_async:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/sync.py:docstring of falcon.util.sync.sync_to_async:: WARNING: py:class reference target not found: function /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/sync.py:docstring of falcon.util.sync.wrap_sync_to_async:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/sync.py:docstring of falcon.util.sync.wrap_sync_to_async:: WARNING: py:class reference target not found: function /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/sync.py:docstring of falcon.util.sync.wrap_sync_to_async_unsafe:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/sync.py:docstring of falcon.util.sync.wrap_sync_to_async_unsafe:: WARNING: py:class reference target not found: function /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/sync.py:docstring of falcon.util.sync.runs_sync:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/deprecation.py:docstring of falcon.util.deprecation.deprecated:: WARNING: py:class reference target not found: optional /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/util/structures.py:docstring of falcon.util.structures.ETag.strong_compare:: WARNING: py:class reference target not found: this /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.TestClient:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.TestClient.simulate_delete:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.TestClient.simulate_get:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.TestClient.simulate_head:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.TestClient.simulate_options:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.TestClient.simulate_patch:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.TestClient.simulate_post:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.TestClient.simulate_put:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.TestClient.simulate_request:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.ASGIConductor:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..async_alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..async_alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..async_alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..async_alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..async_alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..async_alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..async_alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client._simulate_method_alias..async_alias:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.ASGIConductor.simulate_delete:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.ASGIConductor.simulate_get:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.ASGIConductor.simulate_head:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.ASGIConductor.simulate_options:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.ASGIConductor.simulate_patch:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.ASGIConductor.simulate_post:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.ASGIConductor.simulate_put:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.ASGIConductor.simulate_request:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.Result:: WARNING: py:class reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.Result:38: WARNING: py:class reference target not found: CaseInsensitiveDict /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.Result:76: WARNING: py:class reference target not found: JSON serializable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.StreamedResult:48: WARNING: py:class reference target not found: CaseInsensitiveDict /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.StreamedResult:69: WARNING: py:class reference target not found: ResultStream /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_get:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_get:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_head:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_head:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_post:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_post:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_post:: WARNING: py:obj reference target not found: JSON serializable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_put:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_put:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_put:: WARNING: py:obj reference target not found: JSON serializable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_options:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_options:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_patch:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_patch:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_patch:: WARNING: py:obj reference target not found: JSON serializable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_delete:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_delete:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_delete:: WARNING: py:obj reference target not found: JSON serializable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_request:: WARNING: py:class reference target not found: falcon.testing.client._ResultBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/client.py:docstring of falcon.testing.client.simulate_request:: WARNING: py:obj reference target not found: JSON serializable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/helpers.py:docstring of falcon.testing.helpers.ASGIResponseEventCollector:8: WARNING: py:class reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/helpers.py:docstring of falcon.testing.helpers.ASGIResponseEventCollector:16: WARNING: py:class reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/helpers.py:docstring of falcon.testing.helpers.ASGIResponseEventCollector:30: WARNING: py:class reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/helpers.py:docstring of falcon.testing.helpers.closed_wsgi_iterable:: WARNING: py:class reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/helpers.py:docstring of falcon.testing.helpers.closed_wsgi_iterable:: WARNING: py:class reference target not found: iterator /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/test_case.py:docstring of falcon.testing.test_case.TestCase:5: WARNING: py:mod reference target not found: testtools /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/test_case.py:docstring of falcon.testing.test_case.TestCase:13: WARNING: py:class reference target not found: testtools.TestCase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/falcon/testing/resource.py:docstring of falcon.testing.resource.SimpleTestResource:: WARNING: py:obj reference target not found: JSON serializable /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/3.0.0.rst:67: WARNING: py:class reference target not found: falcon.http_error.OptionalRepresentation /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/3.0.0.rst:67: WARNING: py:attr reference target not found: falcon.HTTPError.has_representation /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/3.0.0.rst:73: WARNING: py:class reference target not found: falcon.http_error.NoRepresentation /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/3.0.0.rst:152: WARNING: py:meth reference target not found: falcon.media.Handlers.find_by_media_type /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:181: WARNING: py:meth reference target not found: functools.wraps /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:183: WARNING: py:class reference target not found: NoRepresentation /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:204: WARNING: py:data reference target not found: falcon.DEFAULT_MEDIA_TYPE /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:204: WARNING: py:data reference target not found: falcon.MEDIA_JSON /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:222: WARNING: py:mod reference target not found: six /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:222: WARNING: py:mod reference target not found: python-mimeparse /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:337: WARNING: py:meth reference target not found: uri.decode /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:347: WARNING: py:data reference target not found: falcon.DEFAULT_MEDIA_TYPE /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:347: WARNING: py:data reference target not found: falcon.MEDIA_JSON /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:369: WARNING: py:class reference target not found: falcon.CaseInsensitiveDict /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:369: WARNING: py:class reference target not found: collections.MutableMapping /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:373: WARNING: py:meth reference target not found: functools.wraps /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/2.0.0.rst:379: WARNING: py:class reference target not found: NoRepresentation /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.4.0.rst:39: WARNING: py:meth reference target not found: falcon.routing.create_http_method_map /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.2.0.rst:59: WARNING: py:attr reference target not found: Response.stream /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.1.0.rst:21: WARNING: py:meth reference target not found: falcon.Request.get_param_as_dict /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.1.0.rst:104: WARNING: py:meth reference target not found: inspect.signature /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.1.0.rst:104: WARNING: py:meth reference target not found: inspect.getargspec /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.0.0.rst:10: WARNING: py:meth reference target not found: process_resource /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.0.0.rst:14: WARNING: py:meth reference target not found: process_resource /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.0.0.rst:36: WARNING: py:attr reference target not found: Response.body_encoded /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.0.0.rst:87: WARNING: py:class reference target not found: falcon.testing.TestBase /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.0.0.rst:108: WARNING: py:attr reference target not found: Response.content_range /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/1.0.0.rst:129: WARNING: py:meth reference target not found: functools.partial /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/0.3.0.rst:8: WARNING: py:meth reference target not found: falcon.routing.util.map_http_methods /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/0.3.0.rst:18: WARNING: py:class reference target not found: API /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/0.3.0.rst:24: WARNING: py:class reference target not found: Request /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/0.3.0.rst:27: WARNING: py:meth reference target not found: Request.get_param /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/0.3.0.rst:33: WARNING: py:attr reference target not found: falcon.HTTP_NO_CONTENT /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/0.3.0.rst:33: WARNING: py:attr reference target not found: falcon.HTTP_204 /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/0.3.0.rst:43: WARNING: py:mod reference target not found: six /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/0.3.0.rst:43: WARNING: py:attr reference target not found: six.PY2 /home/tkloczko/rpmbuild/BUILD/falcon-3.1.0/docs/changes/0.3.0.rst:43: WARNING: py:mod reference target not found: six done build succeeded, 186 warnings. ```

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

vytas7 commented 2 years ago

We do not support -n yet, this is a duplicate of https://github.com/falconry/falcon/issues/1888. Please use -W for the time being.

You can use tox -e docs to build the docs in the same way as we do in the CI. But I'm not opposed to adding sys.path either, particularly considering Falcon has no hard 3rd party dependencies, so it could enable your usage pattern. We can accept a PR if you care to add this statement for us.

kloczek commented 2 years ago

Reported issue has nothing to do with sys.path alteration which I;m using. I've added this only as side note showing how simpler (without tox) build documentation and have guarantee that it will be generated not out of installed module but what is is in source tree.

vytas7 commented 2 years ago

OK, thanks, closing this as a duplicate then.

Duplicates #1888