corydolphin / flask-cors

Cross Origin Resource Sharing ( CORS ) support for Flask
https://flask-cors.readthedocs.io/en/latest/index.html
MIT License
884 stars 139 forks source link

3.0.10: sphinx warnings `reference target not found` #317

Open kloczek opened 2 years ago

kloczek commented 2 years ago

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 v4.5.0 making output directory... done loading intersphinx inventory from http://docs.python.org/objects.inv... intersphinx inventory has moved: http://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] 3 added, 0 changed, 0 removed reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done writing... flask-cors.1 { configuration api } /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/docs/configuration.rst:55: WARNING: py:class reference target not found: re.Pattern /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: iterable /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: regex /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: regex /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: timedelta /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: integer /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/extension.py:docstring of flask_cors.extension.CORS:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/decorator.py:docstring of flask_cors.decorator.cross_origin:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/decorator.py:docstring of flask_cors.decorator.cross_origin:: WARNING: py:class reference target not found: regex /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/decorator.py:docstring of flask_cors.decorator.cross_origin:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/decorator.py:docstring of flask_cors.decorator.cross_origin:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/decorator.py:docstring of flask_cors.decorator.cross_origin:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/decorator.py:docstring of flask_cors.decorator.cross_origin:: WARNING: py:class reference target not found: regex /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/decorator.py:docstring of flask_cors.decorator.cross_origin:: WARNING: py:class reference target not found: timedelta /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/decorator.py:docstring of flask_cors.decorator.cross_origin:: WARNING: py:class reference target not found: integer /home/tkloczko/rpmbuild/BUILD/flask-cors-3.0.10/flask_cors/decorator.py:docstring of flask_cors.decorator.cross_origin:: WARNING: py:class reference target not found: string done build succeeded, 21 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