Skip to content

Use poetry to pin docs dependencies #964

Description

@rmorshea

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.

Activity

  1. added
    type-docsAbout changes and updates to documentation
    on Apr 3, 2023
  2. ZEUS-03 commented on Apr 17, 2023

    @ZEUS-03
    Contributor

    can you please elaborate the issue?

  3. Archmonger commented on Apr 17, 2023

    @Archmonger
    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.

  4. rmorshea commented on Apr 23, 2023

    @rmorshea
    CollaboratorAuthor

    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.

  5. ZEUS-03 commented on Apr 23, 2023

    @ZEUS-03
    Contributor

    @rmorshea learned a lot! Thanks for the opportunity.

  6. rmorshea commented on Apr 23, 2023

    @rmorshea
    CollaboratorAuthor

    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.

  7. ZEUS-03 commented on Apr 24, 2023

    @ZEUS-03
    Contributor

    yeah! sure.

  8. changed the title [-]Pin Versions in Docs Container[/-] [+]Use `poetry` to pin docs dependencies[/+] on Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    type-docsAbout changes and updates to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions