ReproNim / reproman

ReproMan (AKA NICEMAN, AKA ReproNim TRD3)
https://reproman.readthedocs.io
Other
24 stars 14 forks source link

DOC: Add sections on managing resources and execution #485

Closed kyleam closed 4 years ago

kyleam commented 4 years ago

This series extends the documentation. Commits 1-4 are cleanup/setup commits. Commit 5 adds a page on managing resources, and commit 6 adds a page on execution that's mostly dedicated to reproman run. I'm not sure I'm happy with the state of the run parts, but I think it passes the threshold of "more useful than nothing at all".

To generate the html output for review, you can run make -C docs html. Perhaps there's enough here that it's now worth hosting somewhere (probably either readthedocs or github pages).

yarikoptic commented 4 years ago

Now we have https://reproman.readthedocs.io/en/latest/

I guess we could just merge and proceed from there if you don't mind, so we could review rendered version etc

kyleam commented 4 years ago

I guess we could just merge and proceed from there if you don't mind, so we could review rendered version etc

I don't know what all "etc" encompasses, but reviewing the rendered version locally is easy enough to do. Let's not avoid a normal review process for that reason.

yarikoptic commented 4 years ago

"etc." == ", users could find rendered version (some documentation is better than no documentation, see how it would look in production (different sphinx/extensions could render differently), etc." ;-) But ok, I will review from local rendering

codecov[bot] commented 4 years ago

Codecov Report

Merging #485 into master will increase coverage by <.01%. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #485      +/-   ##
==========================================
+ Coverage   89.64%   89.64%   +<.01%     
==========================================
  Files         148      148              
  Lines       12182    12193      +11     
==========================================
+ Hits        10920    10931      +11     
  Misses       1262     1262
Impacted Files Coverage Δ
formatters.py 86.58% <100%> (+0.08%) :arrow_up:
reproman/resource/tests/test_docker_container.py 100% <0%> (ø) :arrow_up:
reproman/interface/run.py 100% <0%> (ø) :arrow_up:
reproman/utils.py 86.86% <0%> (+0.02%) :arrow_up:
reproman/resource/docker_container.py 94.15% <0%> (+0.15%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update a5da59d...51bfd60. Read the comment docs.

yarikoptic commented 4 years ago

Great beginning! ;) I have pushed a few minor tune ups, and will merge as soon as tests pass

kyleam commented 4 years ago

I have pushed a few minor tune ups, and will merge as soon as tests pass

Please wait for me to have a chance to look at your changes.

yarikoptic commented 4 years ago

Please wait for me to have a chance to look at your changes.

Thanks for the review! Let me merge as is now and then proceed with tune ups in a follow up PR. I would like to refer to the doc in a reply to a question on NeuroStars.