Skip to content

PRs creating extensions will always fail the documentation check #6470

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

Closed
jacobtylerwalls opened this issue Apr 28, 2022 · 2 comments · Fixed by #6499
Closed

PRs creating extensions will always fail the documentation check #6470

jacobtylerwalls opened this issue Apr 28, 2022 · 2 comments · Fixed by #6499
Labels
Documentation 📗 Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors

Comments

@jacobtylerwalls
Copy link
Member

jacobtylerwalls commented Apr 28, 2022

#6058 generates links to GitHub pages for optional checkers. This page won't actually be live until a new checker is merged.

#6292 added a documentation check to CI.

The combination of these two facts means PRs adding extensions will always fail the documentation check. We can tolerate that, I guess, but are there better ideas?

See https://github.com/PyCQA/pylint/runs/6210620669?check_suite_focus=true

@DanielNoord
Copy link
Collaborator

Ah that's oversight on my part.

Can this be fixed by using internal links instead? Those should pass linkcheck as that runs after documentation has been built.

@DanielNoord
Copy link
Collaborator

I just checked and we can't use an internal link here. We can use linkcheck_ignore though, see https://www.sphinx-doc.org/en/master/usage/configuration.html?highlight=linkcheck#options-for-the-linkcheck-builder.

Adding the extensions folder on Github should fix this issue.

@DanielNoord DanielNoord added Help wanted 🙏 Outside help would be appreciated, good for new contributors Good first issue Friendly and approachable by new contributors labels May 1, 2022
@Pierre-Sassoulas Pierre-Sassoulas removed this from the 2.14.0 milestone May 2, 2022
@DanielNoord DanielNoord added this to the 2.14.0 milestone May 5, 2022
@Pierre-Sassoulas Pierre-Sassoulas removed this from the 2.14.0 milestone May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📗 Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants