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

Check documentation for dead links #1235

Open
Huite opened this issue Sep 26, 2024 · 1 comment
Open

Check documentation for dead links #1235

Huite opened this issue Sep 26, 2024 · 1 comment
Milestone

Comments

@Huite
Copy link
Contributor

Huite commented Sep 26, 2024

As a follow up to #1233

It's probably worthwhile to check the generated documentation for dead links.

This might be useful:
https://github.com/lycheeverse/lychee/

It has a github action as well.

@github-project-automation github-project-automation bot moved this to 📯 New in iMOD Suite Sep 26, 2024
@JoerivanEngelen JoerivanEngelen moved this from 📯 New to 🤝 Accepted in iMOD Suite Oct 21, 2024
@JoerivanEngelen JoerivanEngelen added this to the v1.0 release milestone Oct 21, 2024
@JoerivanEngelen
Copy link
Contributor

JoerivanEngelen commented Dec 20, 2024

Thanks for suggesting lychee, I ran it locally and it found the following. I don't have enough time now to fix it before the release candidate though unfortunately:

  151728/151728 ━━━━━━━━━━━━━━━━━━━━ Finished extracting links                                                                                                                                                   Issues found in 8 inputs. Find details below.0] https://www.usgs.gov/software/modflow-6-usgs-modular-hydrologic-model

[.\html\_static\webpack-macros.html]:
   [ERROR] file:///C:/src/imod-python/docs/_build/html/_static/%7B%7B%20pathto('_static/scripts/pydata-sphinx-theme.js',%201)%20%7D%7D
   [ERROR] file:///C:/src/imod-python/docs/_build/html/_static/%7B%7B%20pathto('_static/styles/pydata-sphinx-theme.css',%201)%20%7D%7D
   [ERROR] file:///C:/src/imod-python/docs/_build/html/_static/%7B%7B%20pathto('_static/scripts/bootstrap.js',%201)%20%7D%7D
   [ERROR] file:///C:/src/imod-python/docs/_build/html/_static/%7B%7B%20pathto('_static/styles/theme.css',%201)%20%7D%7D

[.\html\api\changelog.html]:
     [404] https://deltares.github.io/imod-python/user_guide/regridding.html
 [TIMEOUT] https://imod.xyz/

[.\html\examples\mf6\ex01_twri.html]:
     [404] https://github.com/MODFLOW-USGS/modflow6-examples/tree/master/notebooks/ex-gwf-twri.ipynb

[.\html\developing\releasing.html]:
     [401] https://dpcbuild.deltares.nl/
     [401] https://dpcbuild.deltares.nl/buildConfiguration/iMOD6_IMODPython_Windows_DeployAll?mode=builds

[.\html\examples\imod-wq\Elder.html]:
     [404] http://www.eng.auburn.edu/~clemept/publsihed_pdf/awrmat.pdf

[.\html\api\generated\select\imod.select.cross_section_line.html]:
     [404] https://github.com/Unidata/MetPy/blob/master/metpy/interpolate/slices.py

[.\html\api\generated\select\imod.select.cross_section_linestring.html]:
     [404] https://github.com/Unidata/MetPy/blob/master/metpy/interpolate/slices.py

[.\html\examples\imod-wq\Hydrocoin.html]:
     [403] https://doi.org/10.1029/97WR01926

@JoerivanEngelen JoerivanEngelen moved this from 🤝 Accepted to 📝Refined in iMOD Suite Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📝Refined
Development

No branches or pull requests

2 participants