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

define readthedocs environment in terms of requirements files #1037

Merged
merged 23 commits into from
Aug 23, 2022

Conversation

emlys
Copy link
Member

@emlys emlys commented Jul 20, 2022

Description

I recently learned that you can reference requirements.txt files from a conda environment.yml. Using that feature, we can deduplicate the ReadTheDocs environment file and be sure it's up to date.

  • Move sphinx requirements from requirements-dev.txt into a new file requirements-docs.txt
  • Rename the RTD environment file from requirements-docs.yml to .readthedocs_environment.yml
  • In .readthedocs_environment.yml, point to the requirements files rather than duplicating the list of requirements
  • In the RTD build config file .readthedocs.yml, update some deprecated syntax, and make use of the new jobs feature to install invest with make install. This is nice because it's consistent with our other CI builds.

In a second PR, I'd like to make some updates to the requirements files.

Checklist

  • Updated HISTORY.rst (if these changes are user-facing)
  • Updated the user's guide (if needed)
  • Tested the affected models' UIs (if relevant)

@emlys emlys self-assigned this Jul 27, 2022
@emlys emlys requested a review from davemfish July 27, 2022 19:52
@emlys
Copy link
Member Author

emlys commented Jul 27, 2022

Lets also squash these commits before merging

@emlys emlys marked this pull request as ready for review August 23, 2022 15:56
@phargogh
Copy link
Member

phargogh commented Aug 23, 2022

Superseded by a merge conflict resolution pr in #1059

Sorry everyone! I accidentally closed this PR when I shouldn't have. Too many tabs open.

@phargogh phargogh closed this Aug 23, 2022
@phargogh phargogh reopened this Aug 23, 2022
Copy link
Contributor

@davemfish davemfish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@davemfish davemfish merged commit 357759f into natcap:main Aug 23, 2022
@emlys emlys deleted the task/deduplicate-rtd-environment-file branch March 8, 2023 01:03
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

Successfully merging this pull request may close these issues.

3 participants