Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.16.2: sphinx warnings reference target not found #417

Open
kloczek opened this issue Mar 23, 2024 · 3 comments
Open

0.16.2: sphinx warnings reference target not found #417

kloczek opened this issue Mar 23, 2024 · 3 comments

Comments

@kloczek
Copy link

kloczek commented Mar 23, 2024

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 v7.2.6
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 17 added, 0 changed, 0 removed
reading sources... [100%] viztracer
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-viztracer.3 { installation basic_usage global_tracer limitations filter custom_event_intro extra_log concurrency remote_attach plugins viztracer custom_event decorator viz_plugin contact license } /home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:22: WARNING: py:class reference target not found: integer
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:36: WARNING: py:class reference target not found: integer
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:48: WARNING: py:class reference target not found: integer
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:60: WARNING: py:class reference target not found: list of string or None
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:84: WARNING: py:class reference target not found: list of string or None
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:108: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:120: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:132: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:144: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:156: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:168: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:180: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:192: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:214: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:272: WARNING: py:class reference target not found: VizEvent
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/viztracer.rst:283: WARNING: py:class reference target not found: callable
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/custom_event.rst:20: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/custom_event.rst:26: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/custom_event.rst:32: WARNING: py:class reference target not found: list of string
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/custom_event.rst:38: WARNING: py:class reference target not found: list of string
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/decorator.rst:20: WARNING: py:class reference target not found: function
/home/tkloczko/rpmbuild/BUILD/viztracer-0.16.2/docs/source/decorator.rst:44: WARNING: py:class reference target not found: function
done
build succeeded, 22 warnings.

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

@gaogaotiantian
Copy link
Owner

I can take a look at this but the docs are built with the makefile which probably does not generate such warnings.

@kloczek
Copy link
Author

kloczek commented Mar 25, 2024

I can take a look at this but the docs are built with the makefile which probably does not generate such warnings.

Because in https://github.com/gaogaotiantian/viztracer/blob/master/docs/Makefile is not used -n option.

@gaogaotiantian
Copy link
Owner

I'm aware of that. I'm not sure having the nitpicky option enabled is the only correct path. I'll take a look at it when I have some time and decide whether it's worth the effort to do that. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants