Bare documentation infrastructure

.github/workflows/check_links.yml

@@ -0,0 +1,27 @@
+# =========== IMPORTANT!! READ THIS!! ============ #
+# This file is used to check links and can be copied to be used for documentation websites.
+
+# When you copy this file, make sure to check and modify the fields
+# that here are marked with `MODIFY`.
+# ============================================== #
+
+name: Check links
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  check-links:
+    uses: access-nri/documentation-infra/.github/workflows/check_links_workflow.yml@v0.3
+    with:
+      repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
+      commit: ${{ github.event.pull_request.head.sha || github.sha }}
+      rtd_project: 'CMIP7-Input'  # MODIFY: change this to the Read the Docs project
+    #   readthedocs_yaml: # MODIFY: Uncomment to add .readthedocs.yaml path. If not included, '.readthedocs.yaml' is used.
+    #   lychee_config: '/path/to/lychee_config.toml' # MODIFY: Uncomment to add lychee config path. If not included, the one from the ACCESS-NRI/documentation-infra repo gets used.
+    # secrets: # MODIFY: Uncomment the lines below if the repo is private. You also need to create a secret named REPO_READ_TOKEN with a token that has repo read permissions.
+    #   repo_read_token: ${{ secrets.REPO_READ_TOKEN }}

documentation/.readthedocs.yaml

@@ -0,0 +1,36 @@
+# =========== IMPORTANT!! READ THIS!! ============ #
+# This file can be copied to be used for websites deployments with RTD.
+# When you copy this file, make sure to check and modify the fields
+# that here are marked with `MODIFY IF NEEDED`.
+
+# The post_build job in this file checks links using ACCESS-Hive-Docs check_links_workflow 
+# (https://github.com/ACCESS-NRI/ACCESS-Hive-Docs/blob/main/.github/workflows/check_links_workflow.yml)
+# By default this uses the ACCESS-Hive-Docs lychee config (https://github.com/ACCESS-NRI/ACCESS-Hive-Docs/blob/main/.github/workflows/lychee_config.toml)
+# To use a custom lychee config, add `.github/workflows/lychee_config.toml` to this repo.
+# ============================================== #
+
+
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# ReadtheDocs config version
+version: 2
+
+# Set the ReadtheDocs Docker image OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+  # jobs:
+    # post_checkout: # MODIFY IF NEEDED: uncomment to cancel the RTD build
+    #   - exit 183
+
+# Build documentation with Mkdocs
+mkdocs:
+  configuration: documentation/mkdocs.yml # MODIFY IF NEEDED: path to mkdocs.yml
+
+# Python requirements to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: documentation/requirements.txt # MODIFY IF NEEDED: path to requirements.txt

documentation/docs/fontello/LICENSE.txt

@@ -0,0 +1,21 @@
+Font license info
+
+
+## Entypo
+
+   Copyright (C) 2012 by Daniel Bruce
+
+   Author:    Daniel Bruce
+   License:   SIL (http://scripts.sil.org/OFL)
+   Homepage:  http://www.entypo.com
+
+
+## Zocial
+
+   Copyright (C) 2012 by Sam Collins
+
+   Author:    Sam Collins
+   License:   MIT (http://opensource.org/licenses/mit-license.php)
+   Homepage:  http://zocial.smcllns.com/
+
+

documentation/docs/fontello/README.txt

@@ -0,0 +1,75 @@
+This webfont is generated by https://fontello.com open source project.
+
+
+================================================================================
+Please, note, that you should obey original font licenses, used to make this
+webfont pack. Details available in LICENSE.txt file.
+
+- Usually, it's enough to publish content of LICENSE.txt file somewhere on your
+  site in "About" section.
+
+- If your project is open-source, usually, it will be ok to make LICENSE.txt
+  file publicly available in your repository.
+
+- Fonts, used in Fontello, don't require a clickable link on your site.
+  But any kind of additional authors crediting is welcome.
+================================================================================
+
+
+Comments on archive content
+---------------------------
+
+- /font/* - fonts in different formats
+
+- /css/*  - different kinds of css, for all situations. Should be ok with 
+  twitter bootstrap. Also, you can skip <i> style and assign icon classes
+  directly to text elements, if you don't mind about IE7.
+
+- demo.html - demo file, to show your webfont content
+
+- LICENSE.txt - license info about source fonts, used to build your one.
+
+- config.json - keeps your settings. You can import it back into fontello
+  anytime, to continue your work
+
+
+Why so many CSS files ?
+-----------------------
+
+Because we like to fit all your needs :)
+
+- basic file, <your_font_name>.css - is usually enough, it contains @font-face
+  and character code definitions
+
+- *-ie7.css - if you need IE7 support, but still don't wish to put char codes
+  directly into html
+
+- *-codes.css and *-ie7-codes.css - if you like to use your own @font-face
+  rules, but still wish to benefit from css generation. That can be very
+  convenient for automated asset build systems. When you need to update font -
+  no need to manually edit files, just override old version with archive
+  content. See fontello source code for examples.
+
+- *-embedded.css - basic css file, but with embedded WOFF font, to avoid
+  CORS issues in Firefox and IE9+, when fonts are hosted on the separate domain.
+  We strongly recommend to resolve this issue by `Access-Control-Allow-Origin`
+  server headers. But if you ok with dirty hack - this file is for you. Note,
+  that data url moved to separate @font-face to avoid problems with <IE9, when
+  string is too long.
+
+- animate.css - use it to get ideas about spinner rotation animation.
+
+
+Attention for server setup
+--------------------------
+
+You MUST setup server to reply with proper `mime-types` for font files -
+otherwise some browsers will fail to show fonts.
+
+Usually, `apache` already has necessary settings, but `nginx` and other
+webservers should be tuned. Here is list of mime types for our file extensions:
+
+- `application/vnd.ms-fontobject` - eot
+- `application/x-font-woff` - woff
+- `application/x-font-ttf` - ttf
+- `image/svg+xml` - svg

documentation/docs/fontello/config.json

@@ -0,0 +1,84 @@
+{
+  "name": "",
+  "css_prefix_text": "icon-",
+  "css_use_suffix": false,
+  "hinting": true,
+  "units_per_em": 1000,
+  "ascent": 850,
+  "glyphs": [
+    {
+      "uid": "39a5a0d7ce8342d149373b2ce219503a",
+      "css": "alert",
+      "code": 59392,
+      "src": "entypo"
+    },
+    {
+      "uid": "959c9a2360ed00ec9c0a75562d30edc4",
+      "css": "cc",
+      "code": 59393,
+      "src": "zocial"
+    },
+    {
+      "uid": "72681d2825fef7fd83711278f845547b",
+      "css": "cc-by",
+      "code": 59394,
+      "src": "entypo"
+    },
+    {
+      "uid": "70a69602cdb2f1140d89ae05e74abcb7",
+      "css": "logout",
+      "code": 59396,
+      "src": "custom_icons",
+      "selected": true,
+      "svg": {
+        "path": "M478.4 90.3C395.9 90.3 315.3 114.7 246.8 160.5 178.3 206.3 124.8 271.4 93.3 347.6 61.7 423.8 53.5 507.6 69.6 588.4 85.6 669.3 125.3 743.6 183.6 801.9 241.9 860.1 316.2 899.8 397.1 915.9 477.9 932 561.7 923.8 637.9 892.2 714.1 860.7 779.2 807.2 825 738.7 870.8 670.1 895.2 589.5 895.2 507.1L765 507.1C765 580.4 737 653.8 681 709.7 569.1 821.7 387.7 821.7 275.7 709.7 163.8 597.8 163.8 416.4 275.7 304.5 331.7 248.5 405 220.5 478.4 220.5L478.4 90.3ZM890.7 377.7L890.7 94.7 607.8 94.7 694 180.9 423.1 451.8 533.6 562.4 804.6 291.5 890.7 377.7Z",
+        "width": 1000
+      },
+      "search": [
+        "logout"
+      ]
+    },
+    {
+      "uid": "2b8ed219b6f23b5db8f5718ff9ce5aeb",
+      "css": "key",
+      "code": 59395,
+      "src": "custom_icons",
+      "selected": true,
+      "svg": {
+        "path": "M2997 500C2997 567.4 2983.8 632.9 2957.7 694.5 2932.6 754 2896.6 807.5 2850.7 853.3 2804.8 899.2 2751.4 935.3 2691.9 960.4 2630.2 986.5 2564.7 999.8 2497.4 999.8 2429.9 999.8 2364.4 986.5 2302.7 960.4 2243.2 935.3 2189.8 899.2 2143.9 853.3 2098.1 807.5 2062.1 754 2036.9 694.5 2026.3 669.5 2017.8 643.8 2011.5 617.7H795.1V801.4C795.1 846 759 882.1 714.5 882.1H581.6C537.1 882.1 500.9 846 500.9 801.4V617.7H439.5V801.4C439.5 846 403.3 882.1 358.8 882.1H225.9C181.4 882.1 145.2 846 145.2 801.4V617.7H118.2C53.3 617.7 0.6 565 0.6 500 0.6 435 53.3 382.3 118.2 382.3H2011.5C2017.8 356.2 2026.3 330.5 2036.9 305.5 2062.1 246 2098.1 192.5 2143.9 146.7 2189.8 100.8 2243.2 64.7 2302.7 39.6 2364.4 13.5 2429.9 0.2 2497.4 0.2 2564.7 0.2 2630.2 13.5 2691.9 39.6 2751.4 64.7 2804.8 100.8 2850.7 146.7 2896.6 192.5 2932.6 246 2957.7 305.5 2983.8 367.1 2997 432.6 2997 500ZM2761.8 500C2761.8 354.2 2643.1 235.6 2497.4 235.6 2351.5 235.6 2232.9 354.2 2232.9 500 2232.9 645.8 2351.5 764.4 2497.4 764.4 2643.1 764.4 2761.8 645.8 2761.8 500Z",
+        "width": 2998
+      },
+      "search": [
+        "key"
+      ]
+    },
+    {
+      "uid": "7523e449ad0bd4432eec68980a7815da",
+      "css": "group-1",
+      "code": 59397,
+      "src": "custom_icons",
+      "selected": true,
+      "svg": {
+        "path": "M1342.9 0C1390.3 0 1428.6 38.3 1428.6 85.7V914.3C1428.6 961.7 1390.3 1000 1342.9 1000H85.7C38.3 1000 0 961.7 0 914.3V85.7C0 38.3 38.3 0 85.7 0ZM207.7 136.9C193.4 130 176.6 136.3 169.7 150.6 163.1 164.9 169.1 182 183.7 188.6L417.4 297.7 185.1 406C170.9 412.6 164.6 429.4 171.1 443.7 178 458 194.9 464.3 209.1 457.7L498 323.1C512.3 316.3 518.3 299.4 511.7 285.1 507.7 276.6 500 270.9 491.4 269.1ZM605.7 402.9C590 402.9 577.1 415.7 577.1 431.4 577.1 447.1 590 460 605.7 460H924.3C940 460 952.9 447.1 952.9 431.4 952.9 415.7 940 402.9 924.3 402.9Z",
+        "width": 1429
+      },
+      "search": [
+        "group-1"
+      ]
+    },
+    {
+      "uid": "5f5eef1d11017966c167b931d7bf3e98",
+      "css": "tip_icon",
+      "code": 59398,
+      "src": "custom_icons",
+      "selected": true,
+      "svg": {
+        "path": "M232.7 964.8L228.7 949.6 166.8 623.1C168.5 622.9 170.3 622.9 172.1 623.1L365.2 643.9C378.9 645.4 388.9 657.7 387.4 671.4L384.2 700.8C430.8 701.2 483.3 704.2 528.1 708.4 552.4 710.7 574.5 713.4 592.2 716.3 609.2 719.2 623.9 722.4 632 726.5 647.4 734.2 656.5 746.3 660.2 760.5 661.3 764.9 661.9 769.4 662 774 672.9 767.2 686.7 758.7 701.1 749.9 733.2 730.2 769.2 708.5 782 702 798.9 693.6 815.9 696.9 829.1 703.7 842.2 710.4 852.9 721.2 859.2 730.9 877.2 759 874.8 790.2 857.5 807.5 855.1 810 850.1 813.7 844.5 817.6 838.6 821.9 830.8 827.2 821.9 833.3 804.1 845.4 781.5 860.3 759.3 874.8 737.2 889.3 715.4 903.4 699.2 913.9 691.1 919.2 684.3 923.5 679.6 926.6 677.3 928.1 675.4 929.3 674.2 930.1L672.3 931.3C634.8 956.3 604.7 968.4 575.7 971.1 546.7 973.8 520.2 967 490.6 957.1L361.3 914 358.7 938.1C358.1 943.1 356.1 947.7 353.1 951.3 349.9 956.9 344.6 961.2 337.9 962.9L263.2 982.6C249.9 986.1 236.2 978.2 232.7 964.8ZM364 888.6L498.5 933.4C527.5 943 549.8 948.4 573.4 946.2 596.8 944 622.9 934.2 658.6 910.4L658.6 910.4 658.7 910.3 665.5 920.8C658.7 910.3 658.7 910.3 658.7 910.3L658.8 910.3 660.6 909.1C661.9 908.3 663.7 907.1 666.1 905.6 670.8 902.5 677.5 898.2 685.6 893 701.8 882.5 723.5 868.4 745.6 853.9 767.8 839.4 790.2 824.5 807.9 812.6 816.7 806.6 824.3 801.4 830 797.3 832.9 795.2 835.2 793.5 837 792.2 837.9 791.5 838.6 790.9 839.1 790.5 839.6 790.1 839.8 789.9 839.8 789.9 846.9 782.8 851.4 765.1 838.1 744.4 834.1 738 826.5 730.5 817.7 725.9 809.1 721.5 800.7 720.6 793.2 724.4 781.6 730.2 746.8 751.2 714.1 771.2 698 781.1 682.6 790.6 671.2 797.7 665.6 801.2 660.9 804.1 657.6 806.1L652.6 809.3C652.6 809.3 652.6 809.3 645.9 798.7L652.6 809.3 652.3 809.5 652 809.6C640.5 816 631.3 821.9 622.8 827.3 619.3 829.5 616 831.6 612.7 833.7 601.4 840.6 590.5 846.7 577.5 849.9 551.4 856.4 520.7 850.7 465.7 829.9 459.2 827.5 456 820.3 458.4 813.8 460.9 807.4 468.1 804.1 474.5 806.5 529.4 827.3 553.6 830.1 571.5 825.6 580.5 823.4 588.8 819.1 599.5 812.4 602.4 810.6 605.5 808.7 608.8 806.6 616.3 801.8 625.1 796.2 635.2 790.4 637.4 781.3 637.7 773.3 636 766.7 634.1 759.5 629.8 753.3 620.8 748.8 616.7 746.7 605.7 743.9 588.1 741 571.2 738.2 549.7 735.6 525.7 733.3 481.4 729.1 429.2 726.2 383.4 725.8L373.9 796.4 364 888.6ZM533.9 120C527 120.2 521.2 114.7 521.1 107.8L519.4 22.3C519.2 15.4 524.7 9.7 531.6 9.6 538.5 9.4 544.2 14.9 544.4 21.8L546.1 107.3C546.2 114.2 540.8 119.9 533.9 120ZM673.8 179.9C668.9 175.1 668.8 167.2 673.7 162.3L725.1 110.1C730 105.2 737.9 105.1 742.8 110 747.7 114.8 747.8 122.7 742.9 127.7L691.5 179.8C686.6 184.7 678.7 184.8 673.8 179.9ZM238.1 310C231.2 310 225.6 315.6 225.6 322.5 225.6 329.4 231.2 335 238.1 335H328.5C335.4 335 341 329.4 341 322.5 341 315.6 335.4 310 328.5 310H238.1ZM738.8 310C731.8 310 726.3 315.6 726.3 322.5 726.3 329.4 731.8 335 738.8 335H829.1C836 335 841.6 329.4 841.6 322.5 841.6 315.6 836 310 829.1 310H738.8ZM391.1 162.3C395.9 167.2 395.9 175.1 391 179.9 386 184.8 378.1 184.7 373.3 179.8L321.8 127.7C317 122.7 317 114.8 322 110 326.9 105.1 334.8 105.2 339.6 110.1L391.1 162.3ZM602 571.6C602 570 601.9 568.4 601.8 566.8 556 584.2 506.3 584.2 460.5 566.8 460.4 568.4 460.3 570 460.3 571.6 460.3 610.7 492 642.4 531.2 642.4 570.3 642.4 602 610.7 602 571.6ZM637.8 440C669.8 411 689.9 369.1 689.9 322.5 689.9 234.8 618.8 163.7 531.2 163.7 443.5 163.7 372.4 234.8 372.4 322.5 372.4 369.1 392.5 411 424.5 440 427.1 443.8 429.6 447.7 432 451.8 439.9 465.5 445.4 479.5 445.4 493.4 445.4 513.3 449.7 530.5 466.3 540.9 473.9 545.7 483.1 548.4 493.5 550.1 504 551.7 516.5 552.3 531.2 552.3 545.8 552.3 558.3 551.7 568.8 550.1 579.2 548.4 588.5 545.7 596 540.9 612.6 530.5 616.9 513.3 616.9 493.4 616.9 479.5 622.4 465.5 630.4 451.8 632.8 447.7 635.3 443.8 637.8 440ZM499.5 224C505.8 221.3 508.7 213.9 506 207.6 503.2 201.2 495.9 198.3 489.5 201.1 459.8 214 438.7 230.7 425.1 251.5 411.6 272.4 406.3 296.4 406.3 322.5 406.3 329.4 411.9 335 418.8 335 425.7 335 431.3 329.4 431.3 322.5 431.3 299.7 435.9 280.9 446.1 265.2 456.3 249.4 473 235.5 499.5 224Z",
+        "width": 1000
+      },
+      "search": [
+        "tip_icon"
+      ]
+    }
+  ]
+}

documentation/docs/fontello/css/animation.css

@@ -0,0 +1,85 @@
+/*
+   Animation example, for spinners
+*/
+.animate-spin {
+  -moz-animation: spin 2s infinite linear;
+  -o-animation: spin 2s infinite linear;
+  -webkit-animation: spin 2s infinite linear;
+  animation: spin 2s infinite linear;
+  display: inline-block;
+}
+@-moz-keyframes spin {
+  0% {
+    -moz-transform: rotate(0deg);
+    -o-transform: rotate(0deg);
+    -webkit-transform: rotate(0deg);
+    transform: rotate(0deg);
+  }
+
+  100% {
+    -moz-transform: rotate(359deg);
+    -o-transform: rotate(359deg);
+    -webkit-transform: rotate(359deg);
+    transform: rotate(359deg);
+  }
+}
+@-webkit-keyframes spin {
+  0% {
+    -moz-transform: rotate(0deg);
+    -o-transform: rotate(0deg);
+    -webkit-transform: rotate(0deg);
+    transform: rotate(0deg);
+  }
+
+  100% {
+    -moz-transform: rotate(359deg);
+    -o-transform: rotate(359deg);
+    -webkit-transform: rotate(359deg);
+    transform: rotate(359deg);
+  }
+}
+@-o-keyframes spin {
+  0% {
+    -moz-transform: rotate(0deg);
+    -o-transform: rotate(0deg);
+    -webkit-transform: rotate(0deg);
+    transform: rotate(0deg);
+  }
+
+  100% {
+    -moz-transform: rotate(359deg);
+    -o-transform: rotate(359deg);
+    -webkit-transform: rotate(359deg);
+    transform: rotate(359deg);
+  }
+}
+@-ms-keyframes spin {
+  0% {
+    -moz-transform: rotate(0deg);
+    -o-transform: rotate(0deg);
+    -webkit-transform: rotate(0deg);
+    transform: rotate(0deg);
+  }
+
+  100% {
+    -moz-transform: rotate(359deg);
+    -o-transform: rotate(359deg);
+    -webkit-transform: rotate(359deg);
+    transform: rotate(359deg);
+  }
+}
+@keyframes spin {
+  0% {
+    -moz-transform: rotate(0deg);
+    -o-transform: rotate(0deg);
+    -webkit-transform: rotate(0deg);
+    transform: rotate(0deg);
+  }
+
+  100% {
+    -moz-transform: rotate(359deg);
+    -o-transform: rotate(359deg);
+    -webkit-transform: rotate(359deg);
+    transform: rotate(359deg);
+  }
+}

documentation/docs/fontello/css/fontello-codes.css

@@ -0,0 +1,8 @@
+
+.icon-alert:before { content: '\e800'; } /* '' */
+.icon-cc:before { content: '\e801'; } /* '' */
+.icon-cc-by:before { content: '\e802'; } /* '' */
+.icon-key:before { content: '\e803'; } /* '' */
+.icon-logout:before { content: '\e804'; } /* '' */
+.icon-group-1:before { content: '\e805'; } /* '' */
+.icon-tip_icon:before { content: '\e806'; } /* '' */