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

Remove link check for dotnet API #103

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

lochhh
Copy link
Collaborator

@lochhh lochhh commented Feb 3, 2025

As we have too many references to "https://learn.microsoft.com/dotnet/api/.*", docs build often fails due to 429 Client Error: Too Many Requests for url.

In this PR we configure linkcheck to ignore the dotnet API website.

@lochhh lochhh requested a review from glopesdev February 3, 2025 17:32
@lochhh lochhh marked this pull request as ready for review February 3, 2025 17:32
Copy link
Collaborator

@glopesdev glopesdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lochhh yes, this makes complete sense. In fact, I would say we can go even further and remove checks on all links from APIs included in the xref section of the docfx.json file since those are all checked by DocFX when building the site (on top of the ones taken online from the dotnet API).

If it is too complicated we can leave them for now, as they should be small in number compared to the others, but leaving it as a note for future reference.

@lochhh
Copy link
Collaborator Author

lochhh commented Feb 6, 2025

@lochhh yes, this makes complete sense. In fact, I would say we can go even further and remove checks on all links from APIs included in the xref section of the docfx.json file since those are all checked by DocFX when building the site (on top of the ones taken online from the dotnet API).

If it is too complicated we can leave them for now, as they should be small in number compared to the others, but leaving it as a note for future reference.

In the PR #49 I have a list of external doc links which are generated alongside the API - I guess we will need to add these as well. But atm, as we're using docfx metadata instead of docfx build, the xrefs are not generated, so there is no need to check these yet (compare for instance "AudioCapture" in Aeon.Acquisition.AeonAudio on our current website vs. on the Doxygen+Breathe preview).

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

Successfully merging this pull request may close these issues.

2 participants