msk-STAPLE icon indicating copy to clipboard operation
msk-STAPLE copied to clipboard

[DOCS] Automating documentation at pushing

Open modenaxe opened this issue 4 years ago • 3 comments
trafficstars

@renaultJB this looks feasible using the python script approach.

Based on this github-learning course I think it is possible to define an action using a Debian Docker image runs the python files on all the relevant paths at each push. That would be pretty cool I think!

modenaxe avatar Apr 01 '21 09:04 modenaxe

Ok, I've found this on the github marketplace. I've not read it yet but it seems to do what we want.

renaultJB avatar Apr 08 '21 21:04 renaultJB

@renaultJB I think this could work. I have done a couple of the GitHub action tutorials, I think I should be able to set it up. Can I try on your sphinx branch?

modenaxe avatar Apr 08 '21 23:04 modenaxe

Yes, you can. The generation of the python code to generate numpy style comments is still pretty experimental. The branch is named sphinx_documentation. I should add a readme.md in the docs folder to explain how to make it works and what are the requirements.

renaultJB avatar Apr 13 '21 10:04 renaultJB