Migrate Continuous Documentation from Vercel to Readthedocs

[Esteban82]

As indicated by @seisman, we need to migrate from Vercel to Readthedocs.

I do not understand much how to do it so I will follow the steps here (GenericMappingTools/pygmt#1859) to do it and the files

As far as I understand I need to:

• Delete package.json and vercel.json.
• Add .readthedocs.yaml and ci/requirements/docs.yml
• Edit conf.py?

Please let me know if this is ok.

[seisman]

• Delete package.json and vercel.json.

Yes

• Add .readthedocs.yaml and ci/requirements/docs.yml

ci/requirements/docs.yml is not needed here, because we have https://github.com/GenericMappingTools/gmt-examples/blob/main/environment.yml.

• Edit conf.py?

Yes.

You also need to sign up ReadTheDocs (https://readthedocs.org/accounts/login/?next=/dashboard/), import the gmt-examples repository, and check the "Build pull requests for this project:" box in the settings.

[Esteban82]

• Edit conf.py?

Yes.

What should I update in conf.py? The file here is quite different from the pygmt file.

[seisman]

• Edit conf.py?

Yes.

What should I update in conf.py? The file here is quite different from the pygmt file.

Just add html_baseurl="https://www.generic-mapping-tools.org/gmt-examples/"

[Esteban82]

You also need to sign up ReadTheDocs (https://readthedocs.org/accounts/login/?next=/dashboard/), import the gmt-examples repository, and check the "Build pull requests for this project:" box in the settings.

Could I do it? Or only the maintainers (in this list) can?

[seisman]

You also need to sign up ReadTheDocs (https://readthedocs.org/accounts/login/?next=/dashboard/), import the gmt-examples repository, and check the "Build pull requests for this project:" box in the settings.

Could I do it? Or only the maintainers (in this list) can?

I think you can. Then you can add others as maintainers. Or I can do it.

[Esteban82]

Or I can do it.

Yes, please do it. Thanks

[seisman]

Or I can do it.

Yes, please do it. Thanks

Done.

[Esteban82]

ci/requirements/docs.yml is not needed here, because we have https://github.com/GenericMappingTools/gmt-examples/blob/main/environment.yml.

Ok. So, I guess that I have to use this environment: environment.yml in the line 26 of .readthedocs.yaml. Right?

[Esteban82]

Or I can do it.

Yes, please do it. Thanks

Done.

Great. There is nothing else to do in ReadTheDocs, is there?

[seisman]

ci/requirements/docs.yml is not needed here, because we have https://github.com/GenericMappingTools/gmt-examples/blob/main/environment.yml.

Ok. So, I guess that I have to use this environment: environment.yml in the line 26 of .readthedocs.yaml. Right?

yes

[seisman]

Or I can do it.

Yes, please do it. Thanks

Done.

Great. There is nothing else to do in ReadTheDocs, is there?

i'm not sure. please try and we will know if there are errors.