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

Adapt to new RTD configuration style #733

Merged
merged 4 commits into from
Aug 9, 2023
Merged

Conversation

glatterf42
Copy link
Member

@glatterf42 glatterf42 commented Aug 7, 2023

This PR aims to get our current RTD builds in line with the upcoming changes to the required configuration file and prevent future build issues due to dependency changes at the same time. See iiasa/ixmp#491 for a detailed description.

Specific to the PR is the attempt to incorporate the latest version of ixmp/main as a requirement. It has been required on RTD in the past, so I migrated that requirement to the automatically created doc/requirements.txt. This might make ci/rtd-requirements.txt useless, but I kept it for now since I don't know which other workflows might rely on it. Also, this PR renames the config file for internal consistency.

How to review

  • Read the diff and note that the CI checks all pass.
  • Activate build on RTD for this branch and check that the builds are successful (note: formats other than HTML are too resource-expansive and will only be built after a merge)
  • Build the documentation and look at the bullet lists.

PR checklist

  • Continuous integration checks all ✅
  • [ ] Add or expand tests; coverage checks both ✅ Internal, docs-related, only need them to build/render correctly
  • [ ] Add, expand, or update documentation. Only related to config of docs.
  • [ ] Update release notes. Only related to config of docs.

* Migrate from Advanced Settings -> Default Settings to conf file
* Pin versions of dependencies
* Manually require latest version of ixmp/main
@glatterf42 glatterf42 added enh New features & functionality docs Documentation labels Aug 7, 2023
@glatterf42 glatterf42 self-assigned this Aug 7, 2023
@codecov
Copy link

codecov bot commented Aug 7, 2023

Codecov Report

Merging #733 (75158d1) into main (0b1983f) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main    #733   +/-   ##
=====================================
  Coverage   94.5%   94.5%           
=====================================
  Files         43      43           
  Lines       3463    3463           
=====================================
  Hits        3273    3273           
  Misses       190     190           

* Update doc/requirements.txt accordingly
* Install with [docs] again via RTD config
* Try without latest version of ixmp/main
@khaeru khaeru merged commit e748b8c into iiasa:main Aug 9, 2023
19 checks passed
@glatterf42 glatterf42 deleted the fix/docs branch August 9, 2023 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation enh New features & functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants