1.3.0: 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 build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
loading intersphinx inventory from http://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://docs.aiohttp.org/en/stable/objects.inv...
intersphinx inventory has moved: http://docs.python.org/3/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] 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-frozenlist.3 { } /home/tkloczko/rpmbuild/BUILD/frozenlist-1.3.0/docs/index.rst:7: WARNING: py:meth reference target not found: FrozenList.freeze
/home/tkloczko/rpmbuild/BUILD/frozenlist-1.3.0/docs/index.rst:7: WARNING: py:class reference target not found: FrozenList
done
build succeeded, 2 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

[Dreamsorcerer]

I'm pretty sure we have these warnings checked in the CI on aiohttp. So, if someone would like to copy that setup into this project, then we can ensure these warnings don't occur in future.

[mjpieters]

I'm pretty sure we have these warnings checked in the CI on aiohttp. So, if someone would like to copy that setup into this project, then we can ensure these warnings don't occur in future.

It's enabled in the Makefile:

.PHONY: doc
doc:
	@make -C docs html SPHINXOPTS="-W --keep-going -n -E"
	@echo "open file://`pwd`/docs/_build/html/index.html"

.PHONY: doc-spelling
doc-spelling:
	@make -C docs spelling SPHINXOPTS="-W --keep-going -n -E"

The CI runs doc-spelling. I'll see about updating the tooling here to do something similar.