CI: Enable readthedocs to build docs on pull requests

akihironitta commented 2 years ago

(this feature requires the admin privilege on Read the Docs)

🚀 Feature

Can be configured from https://readthedocs.org/projects/pytorch-lightning/. See https://docs.readthedocs.io/en/stable/pull-requests.html#configuration for details.

Motivation

This feature ensures the exact same environment for building docs between in each PR and in the readthedocs deployment 🚀
(@Borda might have some thoughts on dropping CircleCI https://github.com/Lightning-AI/lightning/pull/13547#discussion_r915523547.)

Pitch

Enable building docs on each PR following the instructions: https://docs.readthedocs.io/en/stable/pull-requests.html
Drop CircleCI job.

Alternatives

Continue to use CircleCI.

Additional context

https://github.com/readthedocs/readthedocs-docker-images/issues/186

If you enjoy Lightning, check out our other projects! ⚡

Metrics: Machine learning metrics for distributed, scalable PyTorch applications.
Lite: enables pure PyTorch users to scale their existing code on any kind of device while retaining full control over their own loops and optimization logic.
Flash: The fastest way to get a Lightning baseline! A collection of tasks for fast prototyping, baselining, fine-tuning, and solving problems with deep learning.
Bolts: Pretrained SOTA Deep Learning models, callbacks, and more for research and production with PyTorch Lightning and PyTorch.
Lightning Transformers: Flexible interface for high-performance research using SOTA Transformers leveraging Pytorch Lightning, Transformers, and Hydra.

cc @carmocca @akihironitta @borda

akihironitta commented 2 years ago

@Borda @ethanwharris Could you take this? (as I see you two are the maintainers at https://readthedocs.org/projects/pytorch-lightning/)

Borda commented 2 years ago

@akihironitta does this support building multiple docs built from single repo as we have it atm? Maybe we can hold this till we fuse both docs :rabbit:

akihironitta commented 2 years ago

Had a look at the readthedocs documentation, but still not sure if one repository can have multiple documentations...

https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx

Maybe we can hold this till we fuse both docs 🐰

Yes, definitely. (I'm not really following the plan of docs fusion... are we going to host both of them in readthedocs or in gh-pages? I'm asking because if we plan to migrate to gh-pages from readthedocs completely, this is no longer relevant :dog:)

carmocca commented 2 years ago

Drop (docs) CircleCI job.

Why can't we do this already? The job has been commented out for a while

akihironitta commented 2 years ago

@carmocca I think we can proceed forward with this because we'll keep hosting the pl docs on readthedocs after pl and app docs are fused, AFAIK.

cc @Borda as this is something only the readthedocs admin can address.

carmocca commented 2 years ago

CircleCI has been removed now. Can we close this?

akihironitta commented 2 years ago

Looking at the change in #15460, we will not be using readthedocs.org anymore.

@Borda Could you close this issue if it's no longer relevant?

Borda commented 2 years ago

Looking at the change in #15460, we will not be using readthedocs.org anymore.

we will, but readhedocs does not allow build multiple packages from single repo AFAIK sp, we still keep rtfd.org and building our own

akihironitta commented 2 years ago

Could we consider moving forward with this again just for PL docs? Enabling docs build in each PR could've prevented PL docs build failure which is currently being fixed by #15511.

Borda commented 2 years ago

@akihironitta just set, could you pls verify?

akihironitta commented 2 years ago

Lightning-AI / pytorch-lightning