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 #114

Merged
merged 2 commits into from
Aug 9, 2023
Merged

Adapt to new RTD configuration style #114

merged 2 commits into from
Aug 9, 2023

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 this PR is the renaming of 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 Advanced Settings -> Default Settings to config file
* Rename config file for internal consistency
* Pin versions of dependencies to prevent future build issues
@glatterf42 glatterf42 added doc Improvements or additions to documentation enh New features or functionality labels Aug 7, 2023
@glatterf42 glatterf42 self-assigned this Aug 7, 2023
@codecov
Copy link

codecov bot commented Aug 7, 2023

Codecov Report

Merging #114 (16d11a4) into main (ec7e57a) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main    #114   +/-   ##
=====================================
  Coverage   68.4%   68.4%           
=====================================
  Files         63      63           
  Lines       4176    4176           
=====================================
  Hits        2857    2857           
  Misses      1319    1319           

* Update doc/requirements.txt accordingly
* Install with [docs] again via RTD config
@khaeru khaeru merged commit 419615a into main Aug 9, 2023
10 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
doc Improvements or additions to documentation enh New features or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants