# geos-chem-shared-docs

**Repository Path**: CESM-ESCOMP/geos-chem-shared-docs

## Basic Information

- **Project Name**: geos-chem-shared-docs
- **Description**: https://github.com/geoschem/geos-chem-shared-docs.git
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: feature/esmf-8.6.1
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-29
- **Last Updated**: 2025-07-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<img src="https://geoschem.github.io/img/GEOS-Chem_Logo_Light_Background.png" height="60%" width="60%" alt="GEOS-Chem Logo">

# GEOS-Chem Shared Documentation for ReadTheDocs

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

- [geos-chem.readthedocs.io](https://geos-chem.readthedocs.io)
- [gchp.readthedocs.io](https://gchp.readthedocs.io)
- [hemco.readthedocs.io](https://geos-chem.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.