Use poetry to pin docs dependencies #964
Description
Activity
- addedtype-docsAbout changes and updates to documentationAbout changes and updates to documentationflag-good-first-issueA well defined and self-contained task.A well defined and self-contained task.
on Apr 3, 2023 can you please elaborate the issue?
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.
Reacted by Gautam SharmaI'm realizing that a better solution to this problem would be to have a lockfile. Using
pip freezehas 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 adocs/pyproject.tomlfile 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.
Reacted by Gautam Sharma@rmorshea learned a lot! Thanks for the opportunity.
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.
yeah! sure.
- removedflag-good-first-issueA well defined and self-contained task.A well defined and self-contained task.
on Apr 24, 2023 - changed the title
[-]Pin Versions in Docs Container[/-][+]Use `poetry` to pin docs dependencies[/+]on Apr 24, 2023
Current Situation
Dependencies in the container running the docs are not pinned. This can cause issues with stability.
Proposed Actions
Use
poetryto create a reproducible docs environment indocs/pyproject.toml.