MOM6 Documentation

Documentation Development

• esmg-docs development

  make clean; make nortd UPDATEHTMLEQS=Y >& _build/html_dox.txt

  • doxygen html APIs
  • log: doxygen make nortd
  • warning log: doxygen html APIs

    make Clean; mkdir _build; make nortd_latex >& _build/latex_dox.txt

  • doxygen: latex/pdf
  • log: doxygen make nortd_latex
  • warning log: doxygen latex APIs

    make Clean;mkdir _build;make html UPDATEHTMLEQS=Y >& _build/html_log.txt

  • sphinx: html
  • warning log: doxygen
  • log: sphinx: make html >& _build/html_log.txt

    make Clean;mkdir _build;make latexpdf >& _build/latex_log.txt

  • sphinx: latex/pdf
  • warning log: doxygen
  • log: sphinx: make latexpdf

    ReadtheDocs

  • html
  • latex/pdf

  ---

• debug development

  make Clean; mkdir _build; doxygen Doxyfile_rtd_dox >& _build/html_dox_debug.txt

  python ./postProcessEquations.py -d _build -p APIs -b doxygen -s index.html -v -l

  • doxygen html APIs
  • log: doxygen
  • warning log: doxygen html APIs

    make Clean; mkdir _build; make nortd_latex >& _build/latex_dox.txt

    make Clean; mkdir _build

    make html SPHINXOPTS=-vvv DOXYGEN_CONF=Doxyfile_rtd_dox UPDATEHTMLEQS=Y >& _build/debug_log.txt

    make -C _build/doxygen_latex LATEX_CMD="pdflatex -interaction=batchmode" >& latex_log.txt

  • doxygen html APIs
  • doxygen latex/pdf APIs
  • sphinx html RTD
  • log: debug
  • log: latex/pdf
  • warning log: doxygen html APIs