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

Script to check for dead links in Brightway documentation and notebooks #4

Open
cmutel opened this issue Apr 12, 2022 · 1 comment
Open
Labels
funded Funded prizes

Comments

@cmutel
Copy link
Contributor

cmutel commented Apr 12, 2022

Summary

We need a script that can check for dead links in Brightway materials (HTML or JSON; converting Jupyter notebooks to HTML first is OK) and produce a report in something like JSON for links which are broken.

Prize Amount

25 CHF or EUR

Output

Script submitted as a PR to this repo. The script can be in any reasonable language. If there is already a good open source implementation, you can earn the prize by point to it :)

Verification

Verification will be performed against known good and bad web pages and Jupyter notebooks.

@cmutel cmutel added the funded Funded prizes label Apr 12, 2022
@michaelweinold
Copy link

@cmutel, may I suggest we transfer this issue to the documentation repo?
I believe Sphinx core functionality (sphinx.builders.linkcheck.CheckExternalLinksBuilder with the nbsphinx package) should work just fine:

This builder scans all documents for external links, tries to open them with requests, and writes an overview which ones are broken and redirected to standard output and to output.txt in the output directory.

All we would need to do it make sure the output file is written to the right place.

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

No branches or pull requests

2 participants