Skip to content

Cross links to other parts of documentation broken #303

@ppinchuk

Description

@ppinchuk

sup3r version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

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:

: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 😄

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions