Fix links

[sgiarols]

Description

This PR identifies and solves broken links in the documentation

Fixes #125

Type of change

Please add a line in the relevant section of
CHANGELOG.md to
document the change (include PR #) - note reverse order of PR #s.

• New feature (non-breaking change which adds functionality)
• Optimization (non-breaking, back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (whatever its nature)

Key checklist

• All tests pass: $ python -m pytest
• The documentation builds and looks OK: $ python -m sphinx -b html docs docs/build

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[sgiarols]

@dalonsoa
There are more errors shown on the error checker, because changes are applied to fixlinks branch which RdD points to but the link-checker checks on the branch "latest". Maybe the branch where the link-checker works can be configured to work twice on current working branch (there is a time lag between when the PR is launched and when RdD updates the documentation). Or we can leave it as is. Not sure what is best.

[dalonsoa]

I think it looks good for a first pass. Let's see what happens when we merge it.

[dalonsoa]

I think that for this to work it needs to be on the same line:

.. _net present cost: https://www.homerenergy.com/products/pro/docs/3.11/net_present_cost.html # noqa

[dalonsoa]

I've fixed this myself and will merge now.

[dalonsoa]

We will see what is really missing when we merge develop into main and create a new release. Only then the changes will be reflected in Read The Docs.

I would suggest to remove checking links with every PR and push to main and develop and leave only the scheduled and manual options, so the warnings are relevant. Otherwise, the link checker will make no sense.