Skip to content

Commit f5aa347

Browse files
committed
EAMxx: reinstate params and remove glossary
1 parent fa9c719 commit f5aa347

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ site
4444
# Ignore mkdocs site-generated files in eamxx
4545
components/eamxx/site/*
4646
# Ignore auto-generated eamxx_params.md file
47-
components/eamxx/docs/common/eamxx_params.md
47+
components/eamxx/docs/user/eamxx_params.md
4848

4949
# Python packaging
5050
*.egg-info

components/eamxx/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
EAMxx was designed and built from the ground up employing modern C++ in order to
66
embrace leading-edge software practices and enable
7-
"[performance portability](common/glossary.md#performance-portability)"
7+
"[performance portability]"
88
[^perf-port_def] across various
99
leadership-class supercomputers.
1010
The latter goal is achieved by using the Kokkos library.

components/eamxx/mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ nav:
1717
- 'PyEAMxx': 'user/pyeamxx.md'
1818
- 'IO Metadata': 'user/io_metadata.md'
1919
- 'Multi-Instance and NBFB': 'user/multi-instance-mvk.md'
20+
- 'EAMxx runtime parameters': 'user/eamxx_params.md'
2021
- 'Developer Guide':
2122
# - 'Overview': 'developer/index.md'
2223
- 'Quick-start Guide': 'developer/dev_quickstart.md'
@@ -40,7 +41,7 @@ nav:
4041
- 'Technical Guide':
4142
- 'Overview': 'technical/index.md'
4243
- 'AeroCom cloud top': 'technical/aerocom_cldtop.md'
43-
- 'Glossary': 'common/glossary.md'
44+
# - 'Glossary': 'common/glossary.md'
4445

4546
edit_uri: ""
4647

components/eamxx/scripts/eamxx-params-docs-autogen

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
"""
44
This script parses the file `cime_config/namelist_defaults_eamxx.xml'
5-
and generates the markdown file `docs/common/eamxx_params.md`,
5+
and generates the markdown file `docs/user/eamxx_params.md`,
66
containing all the runtime parameters that can be configured via calls
77
to `atmchange` (in the case folder). For each parameter, we also report
88
a doc string and its type, as well as, if present, constraints and valid values.
@@ -91,7 +91,7 @@ def generate_params_docs():
9191

9292
eamxx = pathlib.Path(__file__).parent.parent.resolve()
9393
xml_defaults_file = eamxx / "cime_config" / "namelist_defaults_eamxx.xml"
94-
output_file = eamxx / "docs" / "common" / "eamxx_params.md"
94+
output_file = eamxx / "docs" / "user" / "eamxx_params.md"
9595

9696
print("Generating eamxx params documentation...")
9797
print(f" output file: {output_file}")

0 commit comments

Comments
 (0)