-
Notifications
You must be signed in to change notification settings - Fork 35
Description
sup3r version checks
- I have checked that the issue still exists on the latest versions of the docs on
mainhere
Location of the documentation
Throughout the docs, but especially on the CLI docs page. For example: https://natlabrockies.github.io/sup3r/_cli/sup3r.html#sup3r-forward-pass
It looks like the sup3r.pipeline.forward_pass.ForwardPassStrategy should be clickable, but it isn't
Documentation problem
Some of the links to documentation for classes are not clickable (not linked). For example, the link to sup3r.pipeline.forward_pass.ForwardPassStrategy seems to not work here:
Line 91 in 2670e02
| :class:`sup3r.pipeline.forward_pass.ForwardPassStrategy` module. The config |
Suggested fix for documentation
Update names/paths for the links to work. I think Sphinx throws warnings for all broken links when you run it locally, so should be fairly easy to collect all instances of the broken links.
I would happily do this for you, but I am slammed at the moment. I may be able to come back to this in the future.
Or better yet, maybe this is something Claude can do for you 😄