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

Add .readthedocs.yaml configuration file #307

Merged

Conversation

marcfrederick
Copy link
Member

Read the Docs has started requiring a .readthedocs.yaml configuration file to be present in the repository in order to build the documentation.

https://blog.readthedocs.com/migrate-configuration-v2/

According to the timeline we have until 2023-09-25 to migrate to the new configuration file, but we've already had some builds fail during their 48-hour brownout on 2023-09-04.

Read the Docs has started requiring a .readthedocs.yaml configuration
file to be present in the repository in order to build the
documentation.

https://blog.readthedocs.com/migrate-configuration-v2/

According to the timeline we have until 2023-09-25 to migrate to the new
configuration file, but we've already had some builds fail during their
48-hour brownout on 2023-09-04.
@marcfrederick marcfrederick merged commit afeb2a2 into mwclient:master Sep 5, 2023
7 checks passed
@marcfrederick marcfrederick deleted the feature/fix-readthedocs branch September 5, 2023 22:37
@AdamWill
Copy link
Member

AdamWill commented Sep 5, 2023

I tend to hate hardcoded versions which inevitably go hilariously stale over the years...but at a quick look it seems like there aren't any 'latest' or 'stable' redirects we can use for these, so we're just stuck. :(

@marcfrederick
Copy link
Member Author

marcfrederick commented Sep 5, 2023

Yep, we're pretty much stuck with this -- the setup is more or less copy-paste. The migration guide makes it sound like the requirements.txt is only required for reproducible builds, but without it I've had build failures, so I guess it's required.

@waldyrious
Copy link
Member

FYI, I recently got an email about our ReadTheDocs integration — it seems to be for a separate issue than what's handled in this PR (I've forwarded it to you both so you can check), but I thought I'd take the opportunity to mention publicly that besides access to the mwclient GitHub organization and the mwclient PyPI project, it's also necessary to ensure maintainers have access to the mwclient project on ReadTheDocs.

Hopefully we will later create a proper documentation for project maintenance, mentioning these account access steps that need to be performed when adding new maintainers, the preferred PR merge strategy, etc.; but in the meantime, hopefully this comment will offer something searchable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants