stefankoegl / python-json-patch

Applying JSON Patches in Python
https://python-json-patch.readthedocs.org/
BSD 3-Clause "New" or "Revised" License
440 stars 96 forks source link

1.33: sphinx warnings `reference target not found` #149

Open kloczek opened 1 year ago

kloczek commented 1 year 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 doc build/sphinx/man Running Sphinx v6.2.1 making output directory... done building [mo]: targets for 0 po files that are out of date writing output... building [man]: all manpages updating environment: [new config] 4 added, 0 changed, 0 removed reading sources... [100%] tutorial looking for now-outdated files... none found pickling environment... done checking consistency... done writing... python-json-patch.3 { tutorial mod-jsonpatch commandline } /home/tkloczko/rpmbuild/BUILD/python-json-patch-1.33/jsonpatch.py:docstring of jsonpatch.apply_patch:9: WARNING: py:const reference target not found: True /home/tkloczko/rpmbuild/BUILD/python-json-patch-1.33/jsonpatch.py:docstring of jsonpatch.apply_patch:: WARNING: py:class reference target not found: JsonPointer /home/tkloczko/rpmbuild/BUILD/python-json-patch-1.33/jsonpatch.py:docstring of jsonpatch.make_patch:1: WARNING: py:meth reference target not found: JsonPatch.from_diff /home/tkloczko/rpmbuild/BUILD/python-json-patch-1.33/jsonpatch.py:docstring of jsonpatch.make_patch:: WARNING: py:class reference target not found: JsonPointer done build succeeded, 4 warnings. ```

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

stefankoegl commented 1 year ago

I don't quite understand why sphinx does not find the references. Any idea?