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

Combine requirements-dev.txt and docs/requirements.txt #1118

Open
shaunagm opened this issue Sep 3, 2024 · 2 comments
Open

Combine requirements-dev.txt and docs/requirements.txt #1118

shaunagm opened this issue Sep 3, 2024 · 2 comments
Assignees
Labels
bug Impact - something is currently broken in Parsons and needs to be fixed good first issue These issues are great ones to start working on for Parsons newcomers!

Comments

@shaunagm
Copy link
Collaborator

shaunagm commented Sep 3, 2024

Currently we have three requirements files, the standard one in requirements.txt, a requirements-dev.txt in the top level, and another requirements.txt in the docs folder. The latter has requirements for building docs, and requirements-dev.txt has requirements for testing and linting. There's no reason not to combine the latter two (probably makes sense to remove the requirements.txt in the docs folder).

When doing this, make sure to check our CI workflows - presumably this changes how the docs are automatically built, for instance. We also want to check any of our documentation, like the Contributing Guide, and update instructions there as well.

@shaunagm shaunagm added bug Impact - something is currently broken in Parsons and needs to be fixed good first issue These issues are great ones to start working on for Parsons newcomers! labels Sep 3, 2024
@rdhyee
Copy link

rdhyee commented Sep 5, 2024

I'd like to tackle this issue. Next step is for me to write down what @shaunagm told me over Zoom.

I'm editing this note the next morning to say that now that I've looked at Shauna's comment above that I don't have anything more to write down. I'll have to dig into the issue to have anything substantive to say.

@shaunagm
Copy link
Collaborator Author

shaunagm commented Sep 6, 2024

Note: this comment talks about some relevant CI configuration here: #1122 (comment)

Although right now the CI assumes all dev requirements are in requirements-dev.txt in the main level, and ignores the requirements.txt in the docs repository (I believe!) so it doesn't actually need to be changed when we move docs/requirements.txt to requirements-dev.txt. We'd just be bringing the files in line with the CI. (We still need to double-check the docs build though)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Impact - something is currently broken in Parsons and needs to be fixed good first issue These issues are great ones to start working on for Parsons newcomers!
Projects
None yet
Development

No branches or pull requests

2 participants