Skip to content

Commit

Permalink
Merge branch 'mahf708/docs/docs-build' (PR #6246)
Browse files Browse the repository at this point in the history
Adds instructions to develop E3SM documentation for the GitHub-hosted website
  • Loading branch information
rljacob authored Feb 23, 2024
2 parents 9dcf200 + a9ea0fd commit c041b65
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ DOI: [10.11578/E3SM/dc.20230110.5](http://dx.doi.org/10.11578/E3SM/dc.20230110.5
Please visit the [project website](https://e3sm.org) or our [Confluence site](https://acme-climate.atlassian.net/wiki/spaces/DOC/overview)
for further details.

For questions about the model, use [Github Discussions](https://github.com/E3SM-Project/E3SM/discussions)
For questions about the model, use [Github Discussions](https://github.com/E3SM-Project/E3SM/discussions).

See our Github-hosted documentation at [https://e3sm-project.github.io/E3SM/](https://e3sm-project.github.io/E3SM/).

Table of Contents
--------------------------------------------------------------------------------
Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
The documentation for the components of E3SM is found here.

## Components

- [EAM](./EAM/index.md)
- [EAMxx](./EAMxx/index.md)
- [ELM](./ELM/index.md)
- [MOSART](./MOSART/index.md)

Please see [Developing Docs](https://acme-climate.atlassian.net/wiki/spaces/DOC/pages/3924787306/Developing+Documentation) to learn about developing documentation for E3SM.
1 change: 1 addition & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ site_name: E3SM

nav:
- Introduction: 'index.md'
- 'Developing Docs': 'https://acme-climate.atlassian.net/wiki/spaces/DOC/pages/3924787306/Developing+Documentation'
- Components: '*include ./components/*/mkdocs.yml'

theme:
Expand Down

0 comments on commit c041b65

Please sign in to comment.