-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Implement a configuration variable that controls linkcheck verbosity #10946
Comments
I don't have a strong opinion on this, but I wanted to mention that the
|
That is indeed helpful! I didn't notice them since they showed up in a subdirectory (i.e. Also — my sincere thanks to everyone who contributed the link checking capabilities! We've been finding it to be incredibly helpful. |
cc @jayaddison |
@namurphy if you're on a relatively recent version of It can be supplied via the makefile like this: $ make linkcheck SPHINXOPTS="--quiet" Edit: link fixup |
Thank you for the reply! Running that command gave me: $ make linkcheck SPHINXOPTS="--quiet"
usage: __main__.py [OPTIONS] SOURCEDIR OUTPUTDIR [FILENAMES...]
__main__.py: error: unrecognized arguments: --quiet
make: *** [Makefile:20: linkcheck] Error 2 Edited to add: Removing the WARNING: file '.../docs/quiet' given on command line does not exist, The only links checked appeared to be from the This was with Sphinx 7.2.6. |
Ok, thanks @namurphy - handling of the $ SPHINXOPTS="--quiet" make linkcheck (roughly speaking: what that runs, Sphinx should emit one warning for each linkcheck failure, and very little other output) |
It may need to be A |
Alas, still no luck. Running the commands with either I'm wondering if there's something specific about the configuration for the project I'm testing this on (PlasmaPy). Have you tried these commands on another project? In the meantime I'm going to try updating our Thank you again! |
Thanks @namurphy @AA-Turner - yep, my mistake, that should have been @namurphy I'll check out a local copy of PlasmaPy to investigate this in a bit more detail. |
@namurphy ok, yep - in short, for the
Yep, I've enabled quiet mode while locally linkchecking a few projects, and in my opinion the output that it produces is relatively concise, while including most of the important details (source file, line number) -- essentially, it matches your first alternative description:
|
@jayaddison — This is awesome! Thank you so much! I was able to get To fully close this issue, perhaps we could mention this information in the linkcheck documentation (like something sort of like |
@namurphy -- would you be open to opening such a PR to update the documentation? A |
Is your feature request related to a problem? Please describe.
When using
make linkcheck
, a line is printed for each link that gets checked. This includes broken links, redirects, and working links. One of the pain points of usingmake linkcheck
is scrolling through thousands of links to find only a handful of broken links. The large amount of output for big projects also makes it harder to scroll up to previous commands in a terminal.Describe the solution you'd like
It would be helpful to have a configuration variable that controls the verbosity of the output when using
linkcheck
. This configuration variable could be set such that the working links don't get printed to standard output.Describe alternatives you've considered
linkcheck.txt
, and then dogrep -v " ok " linkcheck.txt
or use other Sphinx flags. Workarounds like this might complicate the workflow, require intermediate knowledge of Unix or Sphinx, and/or take longer to figure out how to set them up than it would to use a configuration variable.Thank you!
The text was updated successfully, but these errors were encountered: