search

saghul / pycares

Python interface for c-ares
https://pypi.org/project/pycares/
MIT License
162 stars 74 forks source link

4.2.0: sphinx warnings `reference target not found` #171

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 v5.0.2 making output directory... done WARNING: html_static_path entry '_static' does not exist building [mo]: targets for 0 po files that are out of date building [man]: all manpages updating environment: [new config] 6 added, 0 changed, 0 removed reading sources... [100%] pycares looking for now-outdated files... none found pickling environment... done checking consistency... done writing... python-pycares.3 { pycares channel constants errno event_loops } /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:270: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:219: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:219: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: string /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/channel.rst:: WARNING: py:class reference target not found: callable /home/tkloczko/rpmbuild/BUILD/pycares-pycares-4.2.0/docs/errno.rst:8: WARNING: py:mod reference target not found: pycares.errno done build succeeded, 15 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

kloczek commented 1 year ago

gentle ping .. 🤔

saghul commented 1 year ago

Sorry, I don't have much time for maintaining this package so these small issues shall remain that way unless someone is inclined to send a patch.