Closed kyleam closed 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
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.
"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
Merging #485 into master will increase coverage by
<.01%
. The diff coverage is100%
.
@@ 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.
Great beginning! ;) I have pushed a few minor tune ups, and will merge as soon as tests pass
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.
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.
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 therun
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).