docs update (new icon)

Author: forman

docs/rule-ref.md

@@ -40,49 +40,49 @@ Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:
 ### :material-bug: `any-spatial-data-var`
 
 A datacube should have spatial data variables.
-[More information.](https://xcube.readthedocs.io/en/latest/cubespec.html#data-model-and-format)
+[:material-information-variant:](https://xcube.readthedocs.io/en/latest/cubespec.html#data-model-and-format)
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
 
 ### :material-bug: `cube-dims-order`
 
 Order of dimensions in spatio-temporal datacube variables should be [time, ..., y, x].
-[More information.](https://xcube.readthedocs.io/en/latest/cubespec.html#data-model-and-format)
+[:material-information-variant:](https://xcube.readthedocs.io/en/latest/cubespec.html#data-model-and-format)
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
 
 ### :material-lightbulb: `data-var-colors`
 
 Spatial data variables should encode xcube color mappings in their metadata.
-[More information.](https://xcube.readthedocs.io/en/latest/cubespec.html#encoding-of-colors)
+[:material-information-variant:](https://xcube.readthedocs.io/en/latest/cubespec.html#encoding-of-colors)
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:
 
 ### :material-lightbulb: `grid-mapping-naming`
 
 Grid mapping variables should be called 'spatial_ref' or 'crs' for compatibility with rioxarray and other packages.
-[More information.](https://xcube.readthedocs.io/en/latest/cubespec.html#spatial-reference)
+[:material-information-variant:](https://xcube.readthedocs.io/en/latest/cubespec.html#spatial-reference)
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:
 
 ### :material-bug: `increasing-time`
 
 Time coordinate labels should be monotonically increasing.
-[More information.](https://xcube.readthedocs.io/en/latest/cubespec.html#temporal-reference)
+[:material-information-variant:](https://xcube.readthedocs.io/en/latest/cubespec.html#temporal-reference)
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
 
 ### :material-bug: `lat-lon-naming`
 
 Latitude and longitude coordinates and dimensions should be called 'lat' and 'lon'.
-[More information.](https://xcube.readthedocs.io/en/latest/cubespec.html#spatial-reference)
+[:material-information-variant:](https://xcube.readthedocs.io/en/latest/cubespec.html#spatial-reference)
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
 
 ### :material-bug: `single-grid-mapping`
 
 A single grid mapping shall be used for all spatial data variables of a datacube.
-[More information.](https://xcube.readthedocs.io/en/latest/cubespec.html#spatial-reference)
+[:material-information-variant:](https://xcube.readthedocs.io/en/latest/cubespec.html#spatial-reference)
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
 

docs/todo.md

@@ -4,9 +4,12 @@
 
 - populate `core` plugin by more rules, see CF site and `cf-check` tool
 - populate `xcube` plugin by more rules
-- add `docs`
+- enhance docs
+  - complete configuration page
+  - provide guide page
   - use mkdocstrings ref syntax in docstrings
   - provide configuration examples (use as tests?)
+  - add `docs_url` to all existing rules 
 
 ## Desired
 

mkruleref.py

@@ -1,5 +1,8 @@
 from xrlint.plugin import Plugin
 
+# for icons, see
+# https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
+
 severity_icons = {
     2: "material-lightning-bolt",
     1: "material-alert",
@@ -12,6 +15,9 @@
     "layout": "material-text",
 }
 
+# read_more_icon = "material-book-open-outline"
+read_more_icon = "material-information-variant"
+
 
 def write_rule_ref_page():
     import xrlint.plugins.core
@@ -41,7 +47,7 @@ def write_plugin_rules(stream, plugin: Plugin):
         )
         stream.write(rule_meta.description or "_No description._")
         if rule_meta.docs_url:
-            stream.write(f"\n[More information.]({rule_meta.docs_url})")
+            stream.write("\n" + f"[:{read_more_icon}:]({rule_meta.docs_url})")
         stream.write("\n\n")
         # List the predefined configurations that contain the rule
         stream.write("Contained in: ")