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

Action for doc-build on Windows #319

Closed
RobPasMue opened this issue Aug 4, 2023 · 7 comments · Fixed by #453
Closed

Action for doc-build on Windows #319

RobPasMue opened this issue Aug 4, 2023 · 7 comments · Fixed by #453
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@RobPasMue
Copy link
Member

RobPasMue commented Aug 4, 2023

The doc-build action only works on UNIX envs. We do have a workflow here that builds it on Windows. I'd like to adapt the actions to also allow Windows builds. Let me work on that. Creating an issue on ansys/actions

Originally posted by @RobPasMue in ansys/pymechanical#243 (comment)

@RobPasMue RobPasMue changed the title The doc-build action only works on UNIX envs. We do have a workflow [here](https://github.com/ansys/pygeometry/blob/main/.github/workflows/ci_cd.yml#L186) that builds it on Windows. I'd like to adapt the actions to also allow Windows builds. Let me work on that. Creating an issue on ansys/actions Action for doc-build on Windows Aug 4, 2023
@RobPasMue RobPasMue self-assigned this Aug 4, 2023
@jorgepiloto
Copy link
Member

Ideally, the workflow should run also under a Windows machine. That is why the "shell" keyword is required. Even though it reads "bash", GitHub takes care of converting Linux commands to Windows ones.

The only thing that could break the compatibility of the action is a non cross-platform command, like the "xvfb-run". If that is the case, we may have to revisit the action implementation for non-screen mode.

@RobPasMue
Copy link
Member Author

I'm not so sure about that... the "make" commands are not available by default on Windows. You have to actively run the .bat scripts we have.

@SMoraisAnsys
Copy link
Contributor

Following this issue, I'll open a PR where doc-build action redirects to _doc-build-windows and _doc-build-linux depending on the OS that one would want to build the documentation. This would help us ensuring that Makefile and make.bat files can be used to build the documentation :)
On top of that I also intend to see how this action can be used to get rid of pyvista/setup-headless-display-action through the use of environment variables and vtk-mesa dependency

@RobPasMue
Copy link
Member Author

Thanks @SMoraisAnsys - ping me if you need anything!

@jorgepiloto jorgepiloto added the documentation Improvements or additions to documentation label Feb 23, 2024
@jorgepiloto jorgepiloto added this to the v6 milestone Feb 23, 2024
@RobPasMue
Copy link
Member Author

Hi @SMoraisAnsys - any updates here?

@SMoraisAnsys
Copy link
Contributor

@RobPasMue Unfortunately I had to focus on other things... However I've "free time" this week and planned to focus on it !

@RobPasMue
Copy link
Member Author

Awesome! Looking forward to it. Ping me in case of doubts or for PR review! :)

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

Successfully merging a pull request may close this issue.

3 participants