https://github.com/geoschem/geos-chem-shared-docs
Common documentation (ReadTheDocs format) that is inlined into GEOS-Chem Classic, GCHP, and HEMCO manuals.
https://github.com/geoschem/geos-chem-shared-docs
atmospheric-chemistry atmospheric-modeling cloud-computing documentation gchp geos-chem hemco readthedocs scientific-computing sphinx
Last synced: 4 months ago
JSON representation
Common documentation (ReadTheDocs format) that is inlined into GEOS-Chem Classic, GCHP, and HEMCO manuals.
- Host: GitHub
- URL: https://github.com/geoschem/geos-chem-shared-docs
- Owner: geoschem
- License: other
- Created: 2020-10-13T22:33:48.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-12-15T21:55:36.000Z (6 months ago)
- Last Synced: 2025-12-19T06:10:48.135Z (6 months ago)
- Topics: atmospheric-chemistry, atmospheric-modeling, cloud-computing, documentation, gchp, geos-chem, hemco, readthedocs, scientific-computing, sphinx
- Language: BibTeX Style
- Homepage:
- Size: 643 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Authors: AUTHORS.txt
Awesome Lists containing this project
README
# 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.