Code

Moving documentation to ReadTheDocs#438

Code

Merged

mkavulich merged 26 commits intoNCAR:mainNCAR/ccpp-scm:mainfrom mkavulich:feature/convert_doc_to_readthedocsmkavulich/ccpp-scm:feature/convert_doc_to_readthedocsCopy head branch name to clipboardApr 3, 2024

+2,919-1,502

Commits

Commits on Mar 11, 2024

• First go at converting LaTeX to Sphinx-compatible RST

  mkavulich

  committed
  3ccf452

  Copy full SHA for 3ccf452

• Initial .readthedocs.yaml

  mkavulich

  committed
  3c65377

  Copy full SHA for 3c65377

• Add conf.py in correct location

  mkavulich

  committed
  70f768b

  Copy full SHA for 70f768b

• Include proper master doc main.rst, fix rogue text in conf.py

  mkavulich

  committed
  45f7454

  Copy full SHA for 45f7454

• Add requirements file for python dependencies

  mkavulich

  committed
  6656e5f

  Copy full SHA for 6656e5f

• Readthedocs insists that we have index.rst

  mkavulich

  committed
  bcb9fa9

  Copy full SHA for bcb9fa9

Commits on Mar 12, 2024

• Apparently chapters are case-sensitive. Fix up acknowledgements, and remove title page.

  mkavulich

  committed
  acd117a

  Copy full SHA for acd117a

• fix image embedding, clean up "preface" table (basically copied from CCPP tech doc), fix deprecated feature in conf.py

  mkavulich

  committed
  d14f369

  Copy full SHA for d14f369

• Update and fix formatting for Introduction chapter

  mkavulich

  committed
  350dda9

  Copy full SHA for 350dda9

• Update and fix formatting for first section of Quick Start chapter

  mkavulich

  committed
  42a5a96

  Copy full SHA for 42a5a96

• Finish formatting Quick Start chapter. Did not make any updates for latest changes or building with spack-stack; that will come in a subsequent PR

  mkavulich

  committed
  1a5dacd

  Copy full SHA for 1a5dacd

• Format "Repository" Chapter, including directory tree with descriptions

  mkavulich

  committed
  0879584

  Copy full SHA for 0879584

• Format "Algorithm" chapter

  mkavulich

  committed
  36fc7e5

  Copy full SHA for 36fc7e5

Commits on Mar 14, 2024

• Format "Cases" and "CCPP Inteface" chapters

  mkavulich

  committed
  5ae4982

  Copy full SHA for 5ae4982

• Formatted final chapter!

  mkavulich

  committed
  c5e711a

  Copy full SHA for c5e711a

• Add PDF for RTD

  mkavulich

  committed
  ca8192b

  Copy full SHA for ca8192b

• WHY ARE MY PDFS NOT SHOWING UP???

  mkavulich

  committed
  ddcece6

  Copy full SHA for ddcece6

• Fix PDF title

  mkavulich

  committed
  465b14b

  Copy full SHA for 465b14b

• Minor fixes to various files, section links, etc.

  mkavulich

  committed
  bce8383

  Copy full SHA for bce8383

• Trying desperately to get the author list to behave

  mkavulich

  committed
  0b55f7a

  Copy full SHA for 0b55f7a

• Remove old users guide

  mkavulich

  committed
  ab288c7

  Copy full SHA for ab288c7

• Fix some figure and section links

  mkavulich

  committed
  49d0f63

  Copy full SHA for 49d0f63

Commits on Mar 19, 2024

• Update Makefile to build using Sphinx

  mkavulich

  committed
  c710498

  Copy full SHA for c710498

• Fix latex make stanza (maybe), add README.md for building documentation

  mkavulich

  committed
  3e34a94

  Copy full SHA for 3e34a94

Commits on Apr 2, 2024

• Address Tracy's comments

  mkavulich

  committed
  7fdf996

  Copy full SHA for 7fdf996

Commits on Apr 3, 2024

• Finish addressing Tracys comments

  mkavulich

  committed
  bfc72d1

  Copy full SHA for bfc72d1