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

Problem in determining the build backend in doc-build actions when no pyproject.toml file exist #544

Closed
SMoraisAnsys opened this issue Aug 19, 2024 · 4 comments · Fixed by #557

Comments

@SMoraisAnsys
Copy link
Contributor

At the moment there is no check on the existence of the pyproject.toml file in our doc build actions. However, this file is leveraged to decide which backend should be used in our CICD, see

if grep -q 'build-backend = "poetry\.core\.masonry\.api"' "pyproject.toml"; then
and
if grep -q 'build-backend = "poetry\.core\.masonry\.api"' "pyproject.toml"; then
.

If this is a requirement then we should put it somewhere in the documentation. If that's not the case then we should fix the current action to add this check. Note that this would help projects which have no pyproject.toml file, e.g. projects mainly composed of examples. Currently, I'm not sure that they are able to use the doc-build action.

Note: speaking of projects without pyproject.toml file, we could use pip as default backend in those cases. What do you think ?

@RobPasMue
Copy link
Member

RobPasMue commented Aug 20, 2024

Which project is still not using pyproject.toml?

@SMoraisAnsys
Copy link
Contributor Author

Which project is still not using pyproject.toml?

I was mainly thinking about example repos, e.g. pymapdl-examples or pymechanical-examples.

I don't think we have other public repos without pyproject.toml

@RobPasMue
Copy link
Member

Fine in that case =)

@MaxJPRey
Copy link
Contributor

Agreed to use pip by default.

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 a pull request may close this issue.

3 participants