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

[bug] 5.0.0: sphinx warnings reference target not found #660

Closed
kloczek opened this issue May 4, 2022 · 1 comment · Fixed by #665
Closed

[bug] 5.0.0: sphinx warnings reference target not found #660

kloczek opened this issue May 4, 2022 · 1 comment · Fixed by #665

Comments

@kloczek
Copy link

kloczek commented May 4, 2022

On building my packages I'm using sphinx-build command with -n switch which shows warmings about missing references. These are not critical issues.
There are as well not only reference target not found warnings.
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
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 7 added, 0 changed, 0 removed
reading sources... [100%] migrating
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/docs/clean.rst:332: ERROR: An option to autoclass is either unknown or has an invalid value: 'autodoc_preserve_defaults'
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/docs/goals.rst:156: ERROR: Unknown target name: "other vectors https://html5sec.org/#css".
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/docs/goals.rst:172: ERROR: Unknown target name: "browser leaks https://browserleaks.com/".
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/docs/goals.rst:173: ERROR: Unknown target name: "http leaks https://github.com/cure53/httpleaks".
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/docs/goals.rst:174: ERROR: Unknown target name: "xs leaks https://xsleaks.dev/".
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-bleach.3 { clean linkify goals dev changes migrating } /home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/__init__.py:docstring of bleach.clean:: WARNING: py:class reference target not found: CSSSanitizer
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/docs/clean.rst:291: WARNING: py:class reference target not found: bleach.css_sanitizer.CSSSanitizer
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/docs/clean.rst:323: WARNING: py:class reference target not found: bleach.css_sanitizer.CSSSanitizer
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/sanitizer.py:docstring of bleach.sanitizer.Cleaner:: WARNING: py:class reference target not found: CSSSanitizer
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/docs/clean.rst:353: WARNING: py:class reference target not found: bleach.sanitizer.BleachSanitizingFilter
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/sanitizer.py:docstring of bleach.sanitizer.BleachSanitizerFilter:: WARNING: py:class reference target not found: Treewalker
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/sanitizer.py:docstring of bleach.sanitizer.BleachSanitizerFilter:: WARNING: py:class reference target not found: CSSSanitizer
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/linkifier.py:docstring of bleach.linkifier.Linker:: WARNING: py:class reference target not found: re
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/linkifier.py:docstring of bleach.linkifier.Linker:: WARNING: py:class reference target not found: re
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/linkifier.py:docstring of bleach.linkifier.Linker:: WARNING: py:class reference target not found: list-of-strings
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/linkifier.py:docstring of bleach.linkifier.LinkifyFilter:: WARNING: py:class reference target not found: TreeWalker
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/linkifier.py:docstring of bleach.linkifier.LinkifyFilter:: WARNING: py:class reference target not found: re
/home/tkloczko/rpmbuild/BUILD/bleach-5.0.0/bleach/linkifier.py:docstring of bleach.linkifier.LinkifyFilter:: WARNING: py:class reference target not found: re
done
build succeeded, 18 warnings.
@kloczek kloczek added the untriaged Bug reports that haven't been triaged label May 4, 2022
@willkg willkg added docs needs-your-help and removed untriaged Bug reports that haven't been triaged labels May 4, 2022
@willkg
Copy link
Member

willkg commented May 4, 2022

Thank you for this!

If someone else wants to throw together a PR, I'd be much obliged. Otherwise, I can probably take a look at it this month.

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

Successfully merging a pull request may close this issue.

2 participants