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 URLs during website build #50

Open
niksirbi opened this issue Nov 6, 2023 · 2 comments
Open

Check URLs during website build #50

niksirbi opened this issue Nov 6, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@niksirbi
Copy link
Member

niksirbi commented Nov 6, 2023

@lochhh has suggested a neat way of handling links in Sphinx.

Essentially, we can have one central place for all links in conf.py, meaning we only need to worry about updating URLs there.
This should reduce the probability of broken links.
I'm happy to implement this here after the above movement PR is merged.

As an additional check, we will implement the checking of URLs during docs build (Sphinx has a "linkcheck" capability), but this will be implemented upstream, in the actions repository.

@niksirbi niksirbi added the enhancement New feature or request label Nov 6, 2023
@niksirbi niksirbi self-assigned this Nov 6, 2023
@adamltyson
Copy link
Member

The link checking is now active as of #53

@niksirbi
Copy link
Member Author

So we now just need to implement the link centralisation in conf.py.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants