Closed aplymill7 closed 4 years ago
Merging #143 into master will not change coverage by
%
. The diff coverage isn/a
.
@@ Coverage Diff @@
## master #143 +/- ##
=======================================
Coverage 72.34% 72.34%
=======================================
Files 8 8
Lines 282 282
=======================================
Hits 204 204
Misses 78 78
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 6d1e798...e476c98. Read the comment docs.
This looks good but in the future we should use restructured text to match the documentation we have now. I don't know if markdown can match our sphinx theme. Maybe you can try to build it to confirm it works.
This looks good but in the future we should use restructured text to match the documentation we have now. I don't know if markdown can match our sphinx theme. Maybe you can try to build it to confirm it works.
Good point, I'll change them to rst. Better for these to be RST and we can leave md for UCs.
Orr I could make in html like the current files. What do you think @jlhitt1993?
I'm actually not sure what's best. I think the purpose of rst is that sphinx can quickly convert them to many file types, depending on what the user wants. But it might be best for now just for us to build the HTML and push that to the repo to simplify.
I agree with Jeremy, if we get something with the html added to the main repo then we can all create branches to work on it. The format isn't very complicated, and I can share resources as they are needed. I can also manage the major formatting issues. The reason I hit a roadblock was mainly because of rapidly changing expectations for the content and instructions that we wanted. If we have everyone contributing, that would speed this up a lot.
Okay sounds good, I'll make them into rst
Okay now they are in rst! 👍
@aplymill7 I think it would be easiest if these were combined into one document but with two sub-headings beneath Basic Operation Instructions. You will also need to add the file to the index.rst file for it to show up in the TOC.
I am not sure what the best workflow for editing both content and formatting of the documentation. Maybe this can be discussed tomorrow.
Good points, I'll make the changes by tomorrow morning. Yeah, let's discuss tomorrow as well.
Combined and included in index.rst now!
This looks good to me!
These operation instructions allow for simple stream-lined use of command line and gui-based versions of the code.
Closes #154