clinica
clinica copied to clipboard
aramis-lab
Add readthedocs deployment
This PR adds support for deploying Clinica's documentation in readthedocs, initially, for testing purposes.
An example of the final render can be seen here: https://clinica--691.org.readthedocs.build/en/691/
There are currently some problems with the automatic configuration done by RTD on the webhook that comunicates with Github:
Same on ClinicaDL. It seems that the github App proposed by RTD doesn't have the correct permissions to send info about the build status. I've been trying to re-configuring from scratch several time without success. If some one want to try it again, please contact me to add him/her to the RDT project maintainers.
This PR is related to #699 . Clinica's team have to decide if you want to migrate the documentation to RTD or not!
Pros
- Offload the maintenance tasks of the hosting webserver in an external service.
- Publishing and deploying is done by external agents.
- Have the same pipeline than ClinicaDL.
Cons
- Less control on the customization of the MkDocs template.
- Need to change references to the doc in all the code (and in Clinica's website).
- In some sporadic cases, RDT doesn't trigger the documentation building as planned (probably related to a misconfiguration of the webhook, to investigate).
- ~~RTD doesn't manage poetry~~ (probably solved after recent release of poetry that allows fine control of optional dependencies).
- Need to communicate to current users in order to update theirs bookmarks.
Anyway, I won't be able to work on these PRs for the moment.
@mdiazmel, is there any update on this PR? Should we close ?
And yes, it can be closed.
Ok thanks for the recap. I'll add to the agenda for discussion on friday.