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

[JOSS review] Avoid separate doc requirements.txt #59

Closed
AdamRJensen opened this issue Sep 12, 2023 · 1 comment
Closed

[JOSS review] Avoid separate doc requirements.txt #59

AdamRJensen opened this issue Sep 12, 2023 · 1 comment

Comments

@AdamRJensen
Copy link
Contributor

AdamRJensen commented Sep 12, 2023

I'm confused as to why there is a separate requirements.txt file for the documentation.

Is there a reason that these dependencies are not listed here:

pvOps/setup.py

Lines 54 to 56 in fe6e657

DOCS_REQUIRE = [
'sphinx == 2.2.0'
]

I see no reason why they should not be included in the DOCS_REQUIRE, which lets you install documentation dependencies the standard way:

pip install pvops[docs]

Also, it's HIGHLY recommended to pin the versions of the documentation dependencies as this often ends up causing trouble down the road!

This is part of a JOSS review: openjournals/joss-reviews#5755

@kbonney
Copy link
Collaborator

kbonney commented Oct 5, 2023

Addressed by #80. Resolution: removed redundant req files and pinned documentation related dependencies.

@kbonney kbonney closed this as completed Oct 5, 2023
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