search

rstcheck / rstcheck-core

Core library behind rstcheck.
http://rstcheck-core.rtfd.io/
MIT License
4 stars 8 forks source link

Erronous info: Hyperlink target "my-reference-label" is not referenced. (sphinx) #4

Open cgsecurity opened 7 years ago

cgsecurity commented 7 years ago

rstcheck reports an errnous problem on the example from http://www.sphinx-doc.org/en/1.4.8/markup/inline.html#cross-referencing-arbitrary-locations

.. _my-reference-label:

Section to cross-reference
--------------------------

This is the text of the section.

It refers to the section itself, see :ref:`my-reference-label`.

index.rst:1: (INFO/1) Hyperlink target "my-reference-label" is not referenced.

myint commented 7 years ago

This may require using the actual sphinx-build frontend. If so, we may need to create a rstcheck plugin for sphinx-build.

greut commented 7 years ago

With Sphinx, I had to ignore some "features".

rstcheck --ignore-directives sphinx,automodule,autoclass,autofunction

teone commented 4 years ago

Creating a .rstcheck.cfg with this content solved it for me

[rstcheck]
report=warning
linjiX commented 3 years ago

This may require using the actual sphinx-build frontend. If so, we may need to create a rstcheck plugin for sphinx-build.

Any update for the plugin?

SturmB commented 3 years ago

I am running into this issue now, as well. I thought it was just VS Code's plugin, but the maintainers there correctly noted that the root of the cause lies within rstcheck.

Although @teone's answer does suppress the notice, it is still very much an erroneous one. It is still a bug that needs to be fixed, just not a major one.

ncalexan commented 3 years ago

This is biting me (well, Mozilla CI) as well. See for example this Phab revision reporting an RST warning that is, I'm pretty confident, not correct: https://phabricator.services.mozilla.com/D122553#3995812.

vineetsharma883 commented 3 years ago

Still facing this error...Any updates for the plugin