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

DM-40495: Better error reporting from Sphinx linkcheck #219

Merged
merged 1 commit into from
Aug 30, 2023
Merged

Conversation

rra
Copy link
Member

@rra rra commented Aug 30, 2023

Sphinx linkcheck doesn't produce a summary of failed links, but it does write one to output.txt. Move the linkcheck command into the Makefile so that we can use shell trickery to display the contents of that file on failure.

Add a help target as the default target in Makefile.

@rra rra requested a review from jonathansick August 30, 2023 18:03
@rra
Copy link
Member Author

rra commented Aug 30, 2023

I know the long-term intention is to add a documenteer command, but I think this shouldn't hurt in the short term until you get a chance to work on that.

@jonathansick jonathansick changed the title DM-40495: Better error reporting from PyPI linkcheck DM-40495: Better error reporting from Sphinx linkcheck Aug 30, 2023
Copy link
Member

@jonathansick jonathansick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great to have for now. I wonder if tox running make means that make is running Python inside tox's environment? I think so?

@rra
Copy link
Member Author

rra commented Aug 30, 2023

Good question! I tested that by running tox run -e docs-linkcheck outside of a virtualenv, and it succeeded despite the fact that a bunch of the dependencies for building the documentation are not installed system-wide, so I am fairly sure that's the case. (And that would make sense since I think the virtualenv is controlled by environment variables that should be inherited.)

Sphinx linkcheck doesn't produce a summary of failed links, but it
does write one to output.txt. Move the linkcheck command into the
Makefile so that we can use shell trickery to display the contents
of that file on failure.

Add a help target as the default target in Makefile.
@rra rra enabled auto-merge August 30, 2023 18:21
@rra rra merged commit f025c2c into main Aug 30, 2023
4 checks passed
@rra rra deleted the tickets/DM-40495 branch August 30, 2023 18:23
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

Successfully merging this pull request may close these issues.

None yet

2 participants