search

courtois-neuromod / cneuromod_docs

Documentation of the Courtois NeuroMod project
http://docs.cneuromod.ca/
Other
6 stars 11 forks source link

Add reference to RTD site #2

Closed emdupre closed 4 years ago

emdupre commented 4 years ago

It would be great to (create ? and) add a link to the RTD site in the repo description on GitHub, as well as in the README.

One fun suggestion in this vein: ReadTheDocs recently released a beta workflow that can run on every PR so you see an updated version of the documentation with your proposed changes. You can see it in action on tedana, for example here.

bpinsard commented 4 years ago

added the link. Will have a look at the option you are describing.

emdupre commented 4 years ago

Sounds good ! If you decide to move forward with it, all you should need to do is email them directly at support@readthedocs.org and ask for it to be enabled.

pbellec commented 4 years ago

the links have been added.

I love the feature integrating updated docs with PR. I have contacted RTD team to request adding the integration to this repo.

Thanks for the tip @emdupre

pbellec commented 4 years ago

btw @emdupre the RTD feature is now activated, and should appear in new pull requests.

Thanks a lot for pointing it out!