search

c3g / GenPipes

GenPipes Read the Docs repository
19 stars 5 forks source link

#DocUpdate: Figure out a way to convert new, updated RTD pipeline reference guide to README.md #37

Closed shaloo closed 1 year ago

shaloo commented 5 years ago

Based on Aug 16, 2019 call with Rola, Hector - I need to figure out a way to make sure all the new layout, updates in each pipeline reference in User Guide here https://genpipes.readthedocs.io/en/latest/user_guide/pipeline_ref.html

can be imported back into GenPipes sources. The reason being, the RTD docs are richer in information with rich media, links, videos etc. Work with Hector to see how this can be done. Try one prototype first and then work the rest of the pipelines.

shaloo commented 5 years ago

@pphector, can you let me know the process of pushing back updated README.md into GenPipes sources. Once that is done, I can pull latest README.md directly into RTD docs in appropriate section of user guide as per #38. Here is a sample copy that I'd like to push back - see https://github.com/c3g/GenPipes/blob/master/docs/source/user_guide/pipelines/gp_rnaseq_light.md in place of the file:

https://bitbucket.org/mugqic/genpipes/src/master/pipelines/rnaseq_light/README.md

I don't have bitbucket account so can't test/validate how the layout looks and if all md syntax used in updated file works for bitbucket. Have tested it for Git though in another sample private project and it renders correctly on Git. Thanks in advance for your help.

shaloo commented 5 years ago

Rola, You have been assigned this just so that you are in the loop for this. I can take care of the remaining here with Hector's help (bitbucket validation pending).