User guide for rv4_10

[avaldebe]

Update the new user guide. Need to define a workflow between:

• [x] use Sphinx o build a documentation sire/pdf docs
  • Developed to build the Python documentation. Supports other languages, including Fortran.
  • Native support on mkdocs
  • Can be installed via pip or conda.
• [ ] use Markdown to build a documentation site with mkdocs
  • MkDocs extensions include:
  • python-markdown-math: standalone math extension using MathJax, which supports LaTeX.
  • markdown-simplechem: Smart formatter for chemical equations
  • Use one of the following tools for building a single pdf version:
  • [ ] mkdocs-pandoc+pandoc
  • [ ] md2pdf
• [ ] continue working on LaTeX on our local machines
• [ ] use LaTeX online on overleaf.com
• [x] use Madoko (LaTeX x Markdown) online on madoko.net

[avaldebe]

Madoko

• Pros:
  • Straightforward LaTeX import.
  • Feature rich.
  • Easy to read and easy to write
  • High quality result.
• Cons:
  • Local application does not work on our old Ubuntu machines
  • Cloud application requires blanket permissions over all github repos.
• Conclusion:
  • Promising, but do not trust the application running on the web browser with all my github repositories.

[avaldebe]

Sphinx

conda environment

# create env
conda create --name sphinx sphinx

# activate env
source activate sphinx

initial setup

sphinx-quickstart

more info at tutorial

create documentation

make latexpdf   # build/latex/emep-ctm.pdf
make man        # build/man/emep-ctm.1
make html       # build/html/