forked from ESCOMP/CTSM
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'update-docs-builder-2' into hillslope-scripts-2
# Conflicts: # .git-blame-ignore-revs # .gitignore # Externals.cfg
- Loading branch information
Showing
1,279 changed files
with
67,618 additions
and
65,979 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| name: docs | ||
|
|
||
| on: | ||
| push: | ||
| paths: | ||
| - 'doc/**' | ||
|
|
||
| pull_request: | ||
| paths: | ||
| - 'doc/**' | ||
|
|
||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| jobs: | ||
|
|
||
| test-build-makefile: | ||
| if: ${{ always() }} | ||
| name: Test building documentation with makefile | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
| lfs: true | ||
| - name: Install python 3.x | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: '3.x' | ||
| # https://github.com/actions/cache/blob/main/examples.md#python---pip | ||
| - name: Cache pip | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: ~/.cache/pip | ||
| key: ${{ runner.os }}-pip-${{ hashFiles('doc/requirements.txt') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-pip- | ||
| - name: Install dependencies | ||
| run: | | ||
| pip install -r doc/requirements.txt | ||
| # Build documentation under ${PWD}/_build | ||
| - name: Build Sphinx docs with makefile | ||
| run: | | ||
| make SPHINXOPTS="-W --keep-going" BUILDDIR=${PWD}/_build -C doc/ html | ||
| test-doc-builder: | ||
| if: ${{ always() }} | ||
| name: Test building documentation with doc-builder | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
| lfs: true | ||
| - name: Install python 3.x | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: '3.x' | ||
| # https://github.com/actions/cache/blob/main/examples.md#python---pip | ||
| - name: Cache pip | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: ~/.cache/pip | ||
| key: ${{ runner.os }}-pip-${{ hashFiles('doc/requirements.txt') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-pip- | ||
| - name: Install dependencies | ||
| run: | | ||
| pip install -r doc/requirements.txt | ||
| # Build documentation under ${PWD}/_build | ||
| - name: Build Sphinx docs with doc-builder | ||
| run: | | ||
| cd doc && ./build_docs -b ${PWD}/_build -c |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| # This is a git submodule file with additional support for | ||
| # git-fleximod (https://github.com/ESMCI/git-fleximod) | ||
| # | ||
| # The additional flags supported by git-fleximod are | ||
| # fxtag - the tag associated with the submodule, this tag can be tested for | ||
| # consistancy with the submodule hash using git-fleximod status | ||
| # the hash can be updated to the tag using git-fleximod update | ||
| # | ||
| # fxrequired - indicates if a given submodule should be checked out on install | ||
| # submoudules can be toplevel or internal and required or optional | ||
| # toplevel means that the submodule should only be checked out if the | ||
| # module is the toplevel of the git repo (is not a submodule itself) | ||
| # internal means that the submodule is needed by the component whether | ||
| # the component is toplevel or the submodule of another repo | ||
| # required means that the submodule should always be checked out | ||
| # optional means that the submodule should only be checked out if the | ||
| # optional flag is provided to git-fleximod or the submodule name is | ||
| # explicitly listed on the git-fleximod command line. | ||
| # | ||
| # fxsparse - this is a path to a git sparse checkout file indicating that the | ||
| # submodule should be checked out in sparse mode | ||
| # | ||
| # fxDONOTUSEurl - this field is used by git-fleximod test to insure that the url is pointing | ||
| # to the official url of the repo and not to an unofficial fork. | ||
| # It is intended for use of github workflows to test commits to protected | ||
| # repository branches. | ||
| # | ||
| [submodule "fates"] | ||
| path = src/fates | ||
| url = https://github.com/NGEET/fates | ||
| fxtag = sci.1.78.2_api.36.0.0 | ||
| fxrequired = AlwaysRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/NCAR/fates-release | ||
|
|
||
| [submodule "cism"] | ||
| path = components/cism | ||
| url = https://github.com/ESCOMP/CISM-wrapper | ||
| fxtag = cismwrap_2_2_002 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESCOMP/CISM-wrapper | ||
|
|
||
| [submodule "rtm"] | ||
| path = components/rtm | ||
| url = https://github.com/ESCOMP/RTM | ||
| fxtag = rtm1_0_80 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESCOMP/RTM | ||
|
|
||
| [submodule "mosart"] | ||
| path = components/mosart | ||
| url = https://github.com/ESCOMP/MOSART | ||
| fxtag = mosart1.1.02 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESCOMP/MOSART | ||
|
|
||
| [submodule "mizuRoute"] | ||
| path = components/mizuRoute | ||
| url = https://github.com/ESCOMP/mizuRoute | ||
| fxtag = cesm-coupling.n02_v2.1.2 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESCOMP/mizuRoute | ||
|
|
||
| [submodule "ccs_config"] | ||
| path = ccs_config | ||
| url = https://github.com/ESMCI/ccs_config_cesm.git | ||
| fxtag = ccs_config_cesm1.0.0 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESMCI/ccs_config_cesm.git | ||
|
|
||
| [submodule "cime"] | ||
| path = cime | ||
| url = https://github.com/ESMCI/cime | ||
| fxtag = cime6.0.246 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESMCI/cime | ||
|
|
||
| [submodule "cmeps"] | ||
| path = components/cmeps | ||
| url = https://github.com/ESCOMP/CMEPS.git | ||
| fxtag = cmeps0.14.77 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESCOMP/CMEPS.git | ||
|
|
||
| [submodule "cdeps"] | ||
| path = components/cdeps | ||
| url = https://github.com/ESCOMP/CDEPS.git | ||
| fxtag = cdeps1.0.48 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESCOMP/CDEPS.git | ||
|
|
||
| [submodule "share"] | ||
| path = share | ||
| url = https://github.com/ESCOMP/CESM_share | ||
| fxtag = share1.0.19 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESCOMP/CESM_share | ||
|
|
||
| [submodule "mct"] | ||
| path = libraries/mct | ||
| url = https://github.com/MCSclimate/MCT | ||
| fxtag = MCT_2.11.0 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/MCSclimate/MCT | ||
|
|
||
| [submodule "parallelio"] | ||
| path = libraries/parallelio | ||
| url = https://github.com/NCAR/ParallelIO | ||
| fxtag = pio2_6_2 | ||
| fxrequired = ToplevelRequired | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/NCAR/ParallelIO | ||
|
|
||
| [submodule "doc-builder"] | ||
| path = doc/doc-builder | ||
| url = https://github.com/ESMCI/doc-builder | ||
| fxtag = v1.0.8 | ||
| fxrequired = ToplevelOptional | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/ESMCI/doc-builder | ||
|
|
||
| [submodule "representative-hillslopes"] | ||
| path = tools/external/representative-hillslopes | ||
| url = https://github.com/swensosc/Representative_Hillslopes | ||
| fxtag = ee75e0a1cf0b582ab27f8b0aa3f0c5b475bdb0ca | ||
| fxrequired = ToplevelOptional | ||
| # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed | ||
| fxDONOTUSEurl = https://github.com/swensosc/Representative_Hillslopes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| name: pre-commit | ||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| pre-commit: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-python@v3 | ||
| - uses: pre-commit/action@v3.0.0 |
Oops, something went wrong.