Fix documentation links #1048
Fix documentation links #1048
Conversation
PGijsbers
left a comment
PGijsbers
left a comment
There was a problem hiding this comment.
Thanks! Automating checking for broken links is awesome :)
Few questions:
- I built the docs locally, but did not check all the links work - is that alright?
- What stops us from referencing numpy docs to turn nitpicky on?
- Could you add this work to
progress.rst?
Yes, you need to explicitly do
The fact that this already took me too long and I didn't have time any more ;) I think nitpicky also complained about the task type enum which I didn't know how to fix.
Sure. |
mfeurer
force-pushed
the
fix_documentation
branch
from
8677756 to
34011ef
Compare
|
The doc jobs fail. |
Yes, the rebase on #1044 made it fail :( I'll be working on that soonish, but probably not this week any more... |
mfeurer
force-pushed
the
fix_documentation
branch
from
218cc46 to
7a00940
Compare
PGijsbers
left a comment
PGijsbers
left a comment
There was a problem hiding this comment.
Let's use the built-in function for generating openml urls. A bit less daunting and, at least as important, more future proof.
Co-authored-by: PGijsbers <[email protected]>
|
Great suggestion, just applied it! |
* fix warnings, make sphinx fail on warnings * fix a few links * fix a bunch of links * fix more links * fix all remaining links * and finally add the link checker * debug workflow * more debug * undo debug * Add to changelog * fix new warning * clean up more errors * Fix link after rebase * Apply suggestions from code review Co-authored-by: PGijsbers <[email protected]> Co-authored-by: PGijsbers <[email protected]>
This aims to fix broken links in the documentation. In order to do so it does:
make checklinkIn the process of creating this PR I opened #1046
and #1047so we can in the future fully automate the process of checking thatall links workwe have references to all objects in the API and examples.