kammerje / spaceKLIP

Pipeline for reducing JWST high-contrast imaging data. Published in Kammerer et al. 2022 and Carter et al. 2022.
https://ui.adsabs.harvard.edu/abs/2022SPIE12180E..3NK/abstract
MIT License
16 stars 9 forks source link

update readthe docs config #104

Closed mperrin closed 8 months ago

mperrin commented 11 months ago

Minor but required update as per https://blog.readthedocs.com/use-build-os-config/

For the record here's a copy of the auto notification email I got from RTD. (Does anyone other than me get the RTD emails for this package, by the way? )

Hello, The build.image config key on .readthedocs.yaml has been deprecated, and will be removed on October 16, 2023. We are sending weekly notifications about this issue to all impacted users, as well as temporary build failures (brownouts) as the date approaches for those who haven't migrated their projects. The timeline for this deprecation is as follows: * Monday, August 28, 2023: Do the first brownout (temporarily enforce this deprecation) for 12 hours: 00:01 PST to 11:59 PST (noon) * Monday, September 18, 2023: Do a second brownout (temporarily enforce this deprecation) for 24 hours: 00:01 PST to 23:59 PST (midnight) * Monday, October 2, 2023: Do a third and final brownout (temporarily enforce this deprecation) for 48 hours: 00:01 PST to October 3, 2023 23:59 PST (midnight) * Monday, October 16, 2023: Fully remove support for building documentation using "build.image" on the configuration file We have identified that the following projects which you maintain, and were built in the last year, are impacted by this deprecation: * [spaceklip](https://urldefense.com/v3/__https://readthedocs.org/projects/spaceklip/__;!!CrWY41Z8OgsX0i-WU-0LuAcUu2o!zV-Sm8pBmabvLIX7NyD7XBacH1_RQCylS6QcAqgvhTIAySum-EdSHn7Gx9eXPnqVwrDnBSPAM_41hJhpqYDW$) Please use build.os on your configuration file to ensure that they continue building successfully and to stop receiving these notifications. If you want to opt-out from these emails, you can [edit your preferences in your account settings](https://urldefense.com/v3/__https://readthedocs.org/accounts/edit/__;!!CrWY41Z8OgsX0i-WU-0LuAcUu2o!zV-Sm8pBmabvLIX7NyD7XBacH1_RQCylS6QcAqgvhTIAySum-EdSHn7Gx9eXPnqVwrDnBSPAM_41hD9XqTMe$). For more information on how to use build.os, [read our blog post](https://urldefense.com/v3/__https://blog.readthedocs.com/use-build-os-config/__;!!CrWY41Z8OgsX0i-WU-0LuAcUu2o!zV-Sm8pBmabvLIX7NyD7XBacH1_RQCylS6QcAqgvhTIAySum-EdSHn7Gx9eXPnqVwrDnBSPAM_41hEYYnN7o$) Get in touch with us [via our support](https://urldefense.com/v3/__https://readthedocs.org/support/__;!!CrWY41Z8OgsX0i-WU-0LuAcUu2o!zV-Sm8pBmabvLIX7NyD7XBacH1_RQCylS6QcAqgvhTIAySum-EdSHn7Gx9eXPnqVwrDnBSPAM_41hCrthAA5$) and let us know if you are unable to use a configuration file for any reason. Keep documenting, Read the Docs
JarronL commented 11 months ago

I am getting these as well.

kammerje commented 8 months ago

I'm not getting these emails. I'm going to merge this with minimal review as discussed with @mperrin.