Add suppress warning type for any `'myst' reference target not found`
See original GitHub issueThe following warning:
../../CONTRIBUTING.md:4: WARNING: 'myst' reference target not found: README.md
doesn’t seem to be raised in the same was as other myst warnings, eg doesn’t have [myst.header]
at the end of the warning.
To Reproduce
Steps to reproduce the behavior:
- Create markdown document with a reference to root level readme eg
[README](README.md)
- Add
suppress_warnings = ['myst.reference']
to sphinxconf.py
- Build docs with sphinx
Expected behavior
Would be nice to suppress any warning by any arbitrary text.
Issue Analytics
- State:
- Created 2 years ago
- Reactions:3
- Comments:15 (7 by maintainers)
Top Results From Across the Web
Changelog - MyST-Parser - Read the Docs
✨ NEW: Add warning types myst.subtype : All parsing warnings are assigned a type/subtype, and also the messages are appended with them. These...
Read more >Sphinx autodoc gives WARNING: py:class reference target ...
This is simply a bug in the Python docs themselves--references to some of the Python built-ins (including type ) do no resolve correctly...
Read more >Changelog
#9917: C and C++, parse fundamental types no matter the order of simple type specifiers. ... #9479: autodoc: Emit a warning if target...
Read more >myst-parser Changelog
... see errors like `WARNING reference target not found`. Markdown links are of the format `[text](link)`. MyST-Parser looks to smartly resolve such links, ......
Read more >sphinx.pdf
Any cross-reference that has no matching target ... A list of warning types to suppress arbitrary warning messages.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@mara004 what worked for me is:
I guess that the need of the original author is to suppress these warnings, not to fix the issue itself. I have the same request.
I include some files in the Sphinx documentation which are targeted at people who navigate the source code in an IDE or in a github or Bitbucket GUI. I include links to certain files which should not be copied to the documentation output, e.g. a header file or source file, to support easy navigation in the code.
The warnings we get are along the lines of:
Wanted behavior: Just remove the link and output the text (if available) or the link.
ideally, all files which are excluded or have different file extension (e.g. *.txt, *.cpp, *.h, *.xml) do not raise a warning, while others do.