geoschem / geos-chem-shared-docs

Common documentation (ReadTheDocs format) that is inlined into GEOS-Chem Classic, GCHP, and HEMCO manuals.

GEOS-Chem Shared Documentation for ReadTheDocs

This repository contains common files that are inlined into these ReadTheDocs sites:

• geos-chem.readthedocs.io
• gchp.readthedocs.io
• hemco.readthedocs.io

Contents

Files

AUTHORS.txt LICENSE.txt

• GEOS-Chem license documents

editing_these_docs.rst

• Instructions on how to update ReadTheDocs documentation.

README.md

• This file.

Folders

biblio/

• Contains bibliography files used for the Key References pages in each of the ReadTheDocs sites listed above.

spack/

• Contains the modules.yaml and packages.yaml for installing libraries via Spack (as featured in the Build Libraries with Spack supplemental guide).

_static/

• Contains image files (*.ico, *.png, *.svg) and Cascading Style Sheets (*.css) used in the ReadTheDocs documentation.

supplemental_guides/

• Contains ReadTheDocs documentation in ReStructured Text (*.rst) for several instructional guides that are inlined into the ReadTheDocs sites listed above.