MICA-MNI / micapipe

micapipe from the Multimodal imaging and connectome analysis lab (http://mica-mni.github.io) at the Montreal Neurological Institute. Read The Docs documentation below
http://micapipe.readthedocs.io
GNU General Public License v3.0
89 stars 31 forks source link

[WIP] Deployment of HTML documentation on alternative webhost #105

Open blaisb opened 11 months ago

blaisb commented 11 months ago

[WIP] Please do not merge

Rumor has it that your online deployment of your documentation seems to break from time to time. I am not exactly familiar with the way readthedocs works as a hosting service, but I am not sure you actually need to go through an alternative online platform to deploy your documentation. I am highly unaware of your field, so if having a readthedocs hosted documentation is a valuable thing for you, forget what I said.

This tentative PR uses a GitHub Actions to generate your webpage. It automatically setups sphinx with your requirement in a CI instance and deploys it automatically on a self-hosted github.io webpage which you would need to create. There is still some slight work required left to do on your side to enable such a github.io webpage, but as far as I remember, it is not a very daunting task.

If you need any help, just ping me. If you find that this solution is not exactly fitting to your specific needs, feel free to close the PR. Ping me if you need additional information.

We use a similar mechanism and the pipeline is pretty much the same https://lethe-cfd.github.io/lethe/index.html

Cheers BB