AtChem / AtChem2

Atmospheric chemistry box-model for the MCM

MIT License

59 stars 23 forks source link

Convert doc to LaTex #385

Closed rs028 closed 5 years ago

rs028 commented 5 years ago

Convert the documentation from markdown to latex files.

codecov[bot] commented 5 years ago

Codecov Report

Merging #385 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #385   +/-   ##
=======================================
  Coverage   88.91%   88.91%           
=======================================
  Files          17       17           
  Lines        2256     2256           
=======================================
  Hits         2006     2006           
  Misses        250      250

Flag	Coverage Δ
#build	`62.6% <ø> (ø)`	:arrow_up:
#tests	`88.07% <ø> (ø)`	:arrow_up:
#unittests	`35.85% <ø> (ø)`	: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 5e7a4da...60c0400. Read the comment docs.

rs028 commented 5 years ago

Needs some tidying up and cleaning of the latex code. The resulting pdf is not pretty but contains all the info in the wiki.

Note: is it good practice to have a binary (pdf) file in a git repo?

spco commented 5 years ago

Looks good - yes, it could do with tidying up e.g. fixing the [{[{ all over the place, replacing them with internal links.

While purists might worry, I've seen many people put a PDF into a git repo, and I think it's a good idea. We should probably make a decision as to whether the PDF should always be updated to reflect the .tex files (I'd vote for this).

Could you share here the compilation commands you're using for LaTeX, so it's easy to reproduce next time.

rs028 commented 5 years ago

Yes, internal links, tables, references are a mess right now. Pandoc works fine but the conversion is not perfect :) I agree the pdf file should always be updated. The compilation command is simply: pdflatex AtChem2-Manual.tex

Will add that to the manual/wiki at some point. I think I will merge this, because I don't have time to do further cleaning right now and I want to focus on the paper.

spco commented 5 years ago

Ok no problem - if I get a spare moment I will do some tidying up of the links etc after you've merged this.

rs028 commented 5 years ago

I would put this as a lower priority tbh. It is something I can do next time I am bored on a plane :)