Skip to content

Use poetry to pin docs dependencies #964

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

Closed
rmorshea opened this issue Apr 3, 2023 · 6 comments · Fixed by #1002
Closed

Use poetry to pin docs dependencies #964

rmorshea opened this issue Apr 3, 2023 · 6 comments · Fixed by #1002
Labels
type-docs About changes and updates to documentation

Comments

@rmorshea
Copy link
Collaborator

rmorshea commented Apr 3, 2023

Current Situation

Dependencies in the container running the docs are not pinned. This can cause issues with stability.

Proposed Actions

Use poetry to create a reproducible docs environment in docs/pyproject.toml.

@rmorshea rmorshea added type-docs About changes and updates to documentation flag-good-first-issue A well defined and self-contained task. labels Apr 3, 2023
@ZEUS-03
Copy link
Contributor

ZEUS-03 commented Apr 17, 2023

can you please elaborate the issue?

@Archmonger
Copy link
Contributor

The package versions in this file need to be pinned, so that when the docs are released we won't run into unexpected build failures.

@rmorshea
Copy link
Collaborator Author

I'm realizing that a better solution to this problem would be to have a lockfile. Using pip freeze has a lot of problems. Unfortunately there aren't any standards around lock files (and there won't be for some time). The most popular solution to this problem is Poetry. The plan then would involve setting up a docs/pyproject.toml file and treating the docs as a proper "application".

Apologies @ZEUS-03, with this change of plans, I'd say this isn't really a "good first issue" anymore.

@ZEUS-03
Copy link
Contributor

ZEUS-03 commented Apr 23, 2023

@rmorshea learned a lot! Thanks for the opportunity.

@rmorshea
Copy link
Collaborator Author

BTW @ZEUS-03, if you're interested in making other contributions I make myself available for office hours twice a week. If those times don't work, start a discussion and we can find a time.

@ZEUS-03
Copy link
Contributor

ZEUS-03 commented Apr 24, 2023

yeah! sure.

@Archmonger Archmonger removed the flag-good-first-issue A well defined and self-contained task. label Apr 24, 2023
@Archmonger Archmonger changed the title Pin Versions in Docs Container Use poetry to pin docs dependencies Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-docs About changes and updates to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants