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

fix: DynamicScrapper #281

Merged
merged 31 commits into from
Mar 8, 2024
Merged

fix: DynamicScrapper #281

merged 31 commits into from
Mar 8, 2024

Conversation

clatapie
Copy link
Collaborator

When merging #197, the following error appeared in the dev documentation:

image

This PR is to fix this rendering error.

@ansys-reviewer-bot
Copy link

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@clatapie clatapie self-assigned this Feb 21, 2024
@github-actions github-actions bot added maintenance Package and maintenance related CI/CD bug Something isn't working labels Feb 21, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation CI/CD and removed CI/CD labels Feb 22, 2024
@github-actions github-actions bot added CI/CD and removed CI/CD labels Feb 22, 2024
@germa89
Copy link
Collaborator

germa89 commented Feb 22, 2024

Are you sure is it a cache issue? The doc run that deployed didnt use the cache.

https://github.com/ansys/pyansys-math/actions/runs/7992151629/job/21825019425#step:9:32

@github-actions github-actions bot added CI/CD and removed CI/CD labels Feb 28, 2024
@github-actions github-actions bot added CI/CD and removed CI/CD labels Feb 28, 2024
@github-actions github-actions bot added CI/CD and removed CI/CD labels Feb 28, 2024
@clatapie
Copy link
Collaborator Author

For some reasons, when using ansys/actions/doc-build@v5, the DynamicScrapper doesn't render correctly.

@github-actions github-actions bot added CI/CD and removed CI/CD labels Feb 28, 2024
@github-actions github-actions bot removed the CI/CD label Feb 28, 2024
@clatapie
Copy link
Collaborator Author

Building documentation with ansys/action:
image

Building documentation manually:
image

I will investigate why using ansys/actions prevents the DynamicScrapper to render correctly. Pinging @AlejandroFernandezLuces for visibility on this topic.

@clatapie
Copy link
Collaborator Author

Disabling the check-link option, fixes the issue with the ansys/action.

Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

Let's use proper boolean env vars - apart from that LGTM

.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
@AlejandroFernandezLuces

So, there is an issue with the interactive documentation when using the link checker from Sphinx, is that the case? Out of curiosity, when you tried manually, you were using the link checker too?

We might have to add a regex for the links from the interactive docs to conf.py to ignore those links rather than not using the link checker, specially if this happens in more libraries.

@AlejandroFernandezLuces
Copy link

AlejandroFernandezLuces commented Feb 29, 2024

I'm not sure, but adding this to the conf.py might work as well, feel free to try it if you have the time 🙂

linkcheck_ignore = [r'*.vtksz']

@RobPasMue
Copy link
Member

So, there is an issue with the interactive documentation when using the link checker from Sphinx, is that the case? Out of curiosity, when you tried manually, you were using the link checker too?

We might have to add a regex for the links from the interactive docs to conf.py to ignore those links rather than not using the link checker, specially if this happens in more libraries.

I agree with @AlejandroFernandezLuces - let's ignore the files where this happens, or the extensions to the files involved.

@github-actions github-actions bot removed the CI/CD label Mar 6, 2024
@clatapie
Copy link
Collaborator Author

clatapie commented Mar 8, 2024

Thank you for your feedbacks @AlejandroFernandezLuces and @RobPasMue.
I tried to use regex expression to fix it but the rendering was still not correct (#e9adfc0 and (cd20ef8)
The only option that I see for now is to disable the check-link option.

@clatapie clatapie enabled auto-merge (squash) March 8, 2024 15:04
@clatapie clatapie merged commit 4df2a0d into main Mar 8, 2024
18 checks passed
@clatapie clatapie deleted the fix/dynamic_scrapper branch March 8, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants