2.1.9: sphinx warnings reference target not found

[kloczek]

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 v5.0.1
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 5 added, 0 changed, 0 removed
reading sources... [100%] quickstart
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/docs/source/installation.rst:12: WARNING: Inline substitution_reference start-string without end-string.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-watchdog.3 { installation quickstart api hacking } /home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/docs/source/quickstart.rst:23: WARNING: py:meth reference target not found: watchdog.observers.Observer.schedule
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/api.py:docstring of watchdog.observers.api.EventQueue:1: WARNING: py:class reference target not found: watchdog.utils.bricks.SkipRepeatsQueue
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/api.py:docstring of watchdog.observers.api.EventQueue:1: WARNING: py:class reference target not found: FileSystemEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/api.py:docstring of watchdog.observers.api.EventEmitter:7: WARNING: py:class reference target not found: watchdog.events.EventQueue
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/api.py:docstring of watchdog.observers.api.EventDispatcher.dispatch_events:1: WARNING: py:class reference target not found: queue.Empty
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/api.py:docstring of watchdog.observers.api.EventDispatcher.dispatch_events:9: WARNING: py:class reference target not found: queue.Empty
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/api.py:docstring of watchdog.observers.api.BaseObserver.dispatch_events:1: WARNING: py:class reference target not found: queue.Empty
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/api.py:docstring of watchdog.observers.api.BaseObserver.dispatch_events:9: WARNING: py:class reference target not found: queue.Empty
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/api.py:docstring of watchdog.observers.api.BaseObserver.on_thread_stop:1: WARNING: py:meth reference target not found: stop
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/api.py:docstring of watchdog.observers.api.BaseObserver.on_thread_stop:1: WARNING: py:meth reference target not found: stop
<unknown>:1: WARNING: py:class reference target not found: watchdog.observers.inotify.InotifyObserver
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/__init__.py:docstring of watchdog.observers:29: WARNING: py:class reference target not found: inotify.InotifyObserver
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/__init__.py:docstring of watchdog.observers:30: WARNING: py:class reference target not found: fsevents.FSEventsObserver
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/__init__.py:docstring of watchdog.observers:31: WARNING: py:class reference target not found: kqueue.KqueueObserver
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/__init__.py:docstring of watchdog.observers:32: WARNING: py:class reference target not found: read_directory_changes.WindowsApiObserver
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/__init__.py:docstring of watchdog.observers:29: WARNING: py:class reference target not found: inotify.InotifyObserver
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/__init__.py:docstring of watchdog.observers:30: WARNING: py:class reference target not found: fsevents.FSEventsObserver
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/__init__.py:docstring of watchdog.observers:31: WARNING: py:class reference target not found: kqueue.KqueueObserver
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/observers/__init__.py:docstring of watchdog.observers:32: WARNING: py:class reference target not found: read_directory_changes.WindowsApiObserver
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/utils/__init__.py:docstring of watchdog.utils.BaseThread:1: WARNING: py:class reference target not found: threading.Thread
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/utils/dirsnapshot.py:docstring of watchdog.utils.dirsnapshot.DirectorySnapshot.stat_info:4: WARNING: py:func reference target not found: mtime
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/utils/dirsnapshot.py:docstring of watchdog.utils.dirsnapshot.DirectorySnapshot.stat_info:4: WARNING: py:func reference target not found: isdir
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.LoggerTrick.on_any_event:6: WARNING: py:class reference target not found: FileSystemEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.LoggerTrick.on_created:6: WARNING: py:class reference target not found: DirCreatedEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.LoggerTrick.on_created:6: WARNING: py:class reference target not found: FileCreatedEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.LoggerTrick.on_deleted:6: WARNING: py:class reference target not found: DirDeletedEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.LoggerTrick.on_deleted:6: WARNING: py:class reference target not found: FileDeletedEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.LoggerTrick.on_modified:6: WARNING: py:class reference target not found: DirModifiedEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.LoggerTrick.on_modified:6: WARNING: py:class reference target not found: FileModifiedEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.LoggerTrick.on_moved:6: WARNING: py:class reference target not found: DirMovedEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.LoggerTrick.on_moved:6: WARNING: py:class reference target not found: FileMovedEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.ShellCommandTrick.on_any_event:6: WARNING: py:class reference target not found: FileSystemEvent
/home/tkloczko/rpmbuild/BUILD/watchdog-2.1.9/src/watchdog/tricks/__init__.py:docstring of watchdog.tricks.AutoRestartTrick.on_any_event:6: WARNING: py:class reference target not found: FileSystemEvent
done
build succeeded, 34 warnings.

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

[BoboTiG]

Thanks for the report!

If someone would like to step in, a CI job will be needed in order to prevent future problem. It could be inspired by the current lint job:

watchdog/.github/workflows/tests.yml

Lines 16 to 29 in ea3d34c

	lint:
	name: Linting
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v2
	- name: Set up Python 3.7
	uses: actions/setup-python@v2
	with:
	python-version: "3.7"
	- name: Install test dependencies
	run: python -m pip install tox
	- name: Run flake8
	run: |
	tox -e flake8

[kloczek]

You should be able to add to your CI that command which I'm using .. for example after build and install😋