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 config file #6

Open
Zh-xy opened this issue Jun 16, 2023 · 3 comments
Open

Add readthedocs.yaml config file #6

Zh-xy opened this issue Jun 16, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Zh-xy
Copy link
Collaborator

Zh-xy commented Jun 16, 2023

Quoting Fridolin's message on Slack, "We have been notified by ReadTheDocs that they are going to deprecate documentation builds that don't use the latest version (v2) of their configuration file. message-ix-buildings is one of two of our projects that doesn't already do that. They have posted a blog article detailing why and when this happens and how such a config file can be created. Please let me know if you have any questions about dealing with this.
Config files in the required format already exist for message_ix, ixmp, message-ix-models etc (though I just noticed that all of them are called .readthedocs.yml instead of .readthedocs.yaml and we should probably rename them) if you want some inspiration. This is not urgent, as the full deprecation will only happen in September, but partial deprecations will happen before that (the first one on July 24), so best not to postpone this too much."

@Zh-xy Zh-xy added the documentation Improvements or additions to documentation label Jun 16, 2023
@glatterf42
Copy link
Member

Just bumping this because I've got an email reminder about adding a config file for RTD for this repo again.

@amastrucci
Copy link
Collaborator

@Zh-xy could you take the lead on this?

@Zh-xy
Copy link
Collaborator Author

Zh-xy commented Jun 30, 2023

Hi all, I've created a .readthedocs.yaml file to be added to the main branch - your reviews are needed to commit to main. If you have any comments or want to add more configuration info, feel free to let me know. We can edit it anytime. Cheers!

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

No branches or pull requests

3 participants