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

Makefile improvements #25

Open
georgkrause opened this issue Mar 16, 2023 · 5 comments
Open

Makefile improvements #25

georgkrause opened this issue Mar 16, 2023 · 5 comments

Comments

@georgkrause
Copy link
Collaborator

I think we should improve the docs Makefile:

  • Add a hint that the available commands are run in docker
  • Provide a build command to build something we can release

@Sporiff Can you help with the second point?

@Sporiff
Copy link
Member

Sporiff commented Mar 16, 2023

For now we can probably just add a simple build command, since I don't expect we'll be adding translations anytime soon.

@Sporiff
Copy link
Member

Sporiff commented Mar 18, 2023

@georgkrause Is there actually a benefit to using the Makefile to build the site? We're only going to be using GH Actions, so using the Poetry action should work fine for this, shouldn't it?

@georgkrause
Copy link
Collaborator Author

@Sporiff What exactly are you referring to by "Poetry action"?

@Sporiff
Copy link
Member

Sporiff commented May 23, 2023

@Sporiff What exactly are you referring to by "Poetry action"?

@georgkrause We have a poetry GitHub action that runs poetry scripts to build things directly. Since we're just going to be running a poetry run sphinx... command anyway, is there are benefit to it being in the Makefile?

@georgkrause
Copy link
Collaborator Author

@Sporiff I think back then we had the plan to build the docs inside of docker, and I don't think this would work with poetry, since it isn't a task runner with all the features. But if this isn't a requirement anymore, we can just drop it.

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

No branches or pull requests

2 participants