From aeaae75081e9464c9acc8fce3efea80c10aaaa38 Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Mon, 23 Dec 2024 13:28:41 +1100 Subject: [PATCH 01/13] Created layer template logic based on bands logic and added layer dummy data --- docs/_templates/product-v2.rst | 42 +++++++++++++++++++ docs/data/product/dea-coastlines/_tables.yaml | 13 ++++++ 2 files changed, 55 insertions(+) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index 3f9112a51..fe783b16d 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -102,6 +102,10 @@ {% set bands_count = bands_table_list | length %} +{% set layers_table_list = page.tables.layers_table | selectattr("name", "!=", None) | list %} + +{% set layers_count = layers_table_list | length %} + {% set page_title = page.data.short_name if page.data.is_latest_version else format_version_number(page.data.version_number) ~ ". " ~ page.data.short_name %} {% set display_title = page.data.short_name if page.data.is_latest_version else page.data.short_name ~ " " ~ format_version_number(page.data.version_number) %} @@ -522,6 +526,44 @@ {{ page.tables.bands_footnote if page.tables.bands_footnote }} {% endif %} + {% if layers_table_list %} + .. rubric:: Layers + :name: layers + :class: h2 + + Lorem ipsum dolor sit amet. + + .. list-table:: + :header-rows: 1 + :name: layers-table + + * - + - Aliases + - Resolution + - No-data + - Units + - Type + - Description + {% for layer in layers_table_list %} + * - **{{ layer.name }}** + - {%- if layer.aliases %} + {%- for alias in layer.aliases %} + | {{ alias }} + {%- endfor %} + {%- else %} + {{ no_data_terms.dash }} + {%- endif %} + - {{ layer.resolution if layer.resolution or layer.resolution == 0 else no_data_terms.dash }} + - {{ layer.nodata if layer.nodata or layer.nodata == 0 else "" }} + - {{ layer.units or no_data_terms.dash }} + - {{ layer.type or no_data_terms.dash }} + - {{ layer.description or no_data_terms.dash }} + {% endfor %} + + {{ page.tables.bands_footnote if page.tables.bands_footnote }} + + {% endif %} + .. rubric:: Product information :name: product-information :class: h2 diff --git a/docs/data/product/dea-coastlines/_tables.yaml b/docs/data/product/dea-coastlines/_tables.yaml index a9bb95932..39ee63f34 100644 --- a/docs/data/product/dea-coastlines/_tables.yaml +++ b/docs/data/product/dea-coastlines/_tables.yaml @@ -12,3 +12,16 @@ # units: null # type: int16 # description: A description of the band. + +# Layers + +layers_footnote: A footnote underneath the table. + +layers_table: + - name: example_layer_name + aliases: [example_alias_1, example_alias_2] + resolution: 30 m + nodata: -999 + units: null + type: int16 + description: A description of the layer. From 9246d2a91598bb597882336799f5ffd384b6f6de Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Mon, 23 Dec 2024 14:00:24 +1100 Subject: [PATCH 02/13] Editing layers figure --- docs/_templates/product-v2.rst | 21 +++---------------- docs/data/product/dea-coastlines/_tables.yaml | 5 ----- 2 files changed, 3 insertions(+), 23 deletions(-) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index fe783b16d..4852298fb 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -531,36 +531,21 @@ :name: layers :class: h2 - Lorem ipsum dolor sit amet. + This product contains the following layers and attribute fields. .. list-table:: :header-rows: 1 :name: layers-table * - - - Aliases - - Resolution - - No-data - - Units - - Type - Description + - Attribute fields {% for layer in layers_table_list %} * - **{{ layer.name }}** - - {%- if layer.aliases %} - {%- for alias in layer.aliases %} - | {{ alias }} - {%- endfor %} - {%- else %} - {{ no_data_terms.dash }} - {%- endif %} - - {{ layer.resolution if layer.resolution or layer.resolution == 0 else no_data_terms.dash }} - - {{ layer.nodata if layer.nodata or layer.nodata == 0 else "" }} - - {{ layer.units or no_data_terms.dash }} - - {{ layer.type or no_data_terms.dash }} - {{ layer.description or no_data_terms.dash }} {% endfor %} - {{ page.tables.bands_footnote if page.tables.bands_footnote }} + {{ page.tables.layers_footnote if page.tables.layers_footnote }} {% endif %} diff --git a/docs/data/product/dea-coastlines/_tables.yaml b/docs/data/product/dea-coastlines/_tables.yaml index 39ee63f34..11d10d143 100644 --- a/docs/data/product/dea-coastlines/_tables.yaml +++ b/docs/data/product/dea-coastlines/_tables.yaml @@ -19,9 +19,4 @@ layers_footnote: A footnote underneath the table. layers_table: - name: example_layer_name - aliases: [example_alias_1, example_alias_2] - resolution: 30 m - nodata: -999 - units: null - type: int16 description: A description of the layer. From 1e0d9ad27c4b30e3baeeec7be636da7ec7334e9e Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Mon, 23 Dec 2024 16:54:02 +1100 Subject: [PATCH 03/13] Adding attributes --- docs/_templates/product-v2.rst | 10 +++---- docs/data/product/dea-coastlines/_tables.yaml | 26 ++++++++----------- 2 files changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index 4852298fb..7cacbd562 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -534,15 +534,15 @@ This product contains the following layers and attribute fields. .. list-table:: - :header-rows: 1 :name: layers-table - * - - - Description - - Attribute fields {% for layer in layers_table_list %} * - **{{ layer.name }}** - - {{ layer.description or no_data_terms.dash }} + - {{ layer.description or no_data_terms.dash }} This layer contains the following attributes. + + {% for attribute in layer.attributes %} + * **{{ attribute.name }}** :raw-html:`&mdash` {{ attribute.description }} + {% endfor %} {% endfor %} {{ page.tables.layers_footnote if page.tables.layers_footnote }} diff --git a/docs/data/product/dea-coastlines/_tables.yaml b/docs/data/product/dea-coastlines/_tables.yaml index 11d10d143..089075408 100644 --- a/docs/data/product/dea-coastlines/_tables.yaml +++ b/docs/data/product/dea-coastlines/_tables.yaml @@ -1,22 +1,18 @@ # See the Product metadata fields documentation: https://docs.dev.dea.ga.gov.au/public_services/dea_knowledge_hub/product_metadata_fields.html -# Bands - -# bands_footnote: A footnote underneath the table. - -# bands_table: -# - name: example_band_name -# aliases: [example_alias_1, example_alias_2] -# resolution: 30 m -# nodata: -999 -# units: null -# type: int16 -# description: A description of the band. - # Layers -layers_footnote: A footnote underneath the table. +layers_footnote: "For more information on these bands, see the `Description tab <./?tab=description>`_." layers_table: - - name: example_layer_name + - name: shorelines_annual description: A description of the layer. + attributes: + - name: year + description: The year of each annual shoreline. + - name: certainty + description: A column providing important data quality flags for each annual shoreline. + - name: tide_datum + description: The tide datum of each annual shoreline (e.g. “0 m AMSL”). + - name: id_primary + description: The name of the annual shoreline’s Primary sediment compartment from the `Australian Coastal Sediment Compartments `_ framework. From 6ec45de4d2c9abb2497042440603ce23be4cb429 Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Mon, 23 Dec 2024 16:59:46 +1100 Subject: [PATCH 04/13] Adding attributes data --- docs/data/product/dea-coastlines/_tables.yaml | 83 ++++++++++++++++++- 1 file changed, 82 insertions(+), 1 deletion(-) diff --git a/docs/data/product/dea-coastlines/_tables.yaml b/docs/data/product/dea-coastlines/_tables.yaml index 089075408..068b8e402 100644 --- a/docs/data/product/dea-coastlines/_tables.yaml +++ b/docs/data/product/dea-coastlines/_tables.yaml @@ -6,8 +6,10 @@ layers_footnote: "For more information on these bands, see the `Description tab layers_table: - name: shorelines_annual - description: A description of the layer. + description: Annual shoreline vectors that represent the median or ‘most representative’ position of the shoreline at approximately 0 m Above Mean Sea Level for each year since 1988. attributes: + - name: id + description: - name: year description: The year of each annual shoreline. - name: certainty @@ -16,3 +18,82 @@ layers_table: description: The tide datum of each annual shoreline (e.g. “0 m AMSL”). - name: id_primary description: The name of the annual shoreline’s Primary sediment compartment from the `Australian Coastal Sediment Compartments `_ framework. + - name: rates_of_change + description: A point dataset providing robust rates of coastal change for every 30 m along Australia’s non-rocky coastlines. + attributes: + - name: id + description: + - name: uid + description: + - name: rate_time + description: + - name: sig_time + description: + - name: se_time + description: + - name: outl_time + description: + - name: dist_1990, dist_1991, etc + description: + - name: angle_std + description: + - name: valid_obs + description: + - name: valid_span + description: + - name: sce + description: + - name: nsm + description: + - name: max_year + description: + - name: min_year + description: + - name: certainty + description: + - name: id_primary + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: + - name: + description: From 21d85184304ce1a32fe594f1639d111123979d4f Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Mon, 23 Dec 2024 17:01:36 +1100 Subject: [PATCH 05/13] layers table --- docs/_templates/product-v2.rst | 2 +- docs/data/product/dea-coastlines/_tables.yaml | 5 +---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index 7cacbd562..688cdab44 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -541,7 +541,7 @@ - {{ layer.description or no_data_terms.dash }} This layer contains the following attributes. {% for attribute in layer.attributes %} - * **{{ attribute.name }}** :raw-html:`&mdash` {{ attribute.description }} + * **{{ attribute.name }}** :raw-html:`—` {{ attribute.description }} {% endfor %} {% endfor %} diff --git a/docs/data/product/dea-coastlines/_tables.yaml b/docs/data/product/dea-coastlines/_tables.yaml index 068b8e402..1c8d3488e 100644 --- a/docs/data/product/dea-coastlines/_tables.yaml +++ b/docs/data/product/dea-coastlines/_tables.yaml @@ -8,8 +8,6 @@ layers_table: - name: shorelines_annual description: Annual shoreline vectors that represent the median or ‘most representative’ position of the shoreline at approximately 0 m Above Mean Sea Level for each year since 1988. attributes: - - name: id - description: - name: year description: The year of each annual shoreline. - name: certainty @@ -18,11 +16,10 @@ layers_table: description: The tide datum of each annual shoreline (e.g. “0 m AMSL”). - name: id_primary description: The name of the annual shoreline’s Primary sediment compartment from the `Australian Coastal Sediment Compartments `_ framework. + - name: rates_of_change description: A point dataset providing robust rates of coastal change for every 30 m along Australia’s non-rocky coastlines. attributes: - - name: id - description: - name: uid description: - name: rate_time From 153bb51351d8f4a6c778f18cdd4eb2fc7195d69f Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Mon, 23 Dec 2024 17:13:44 +1100 Subject: [PATCH 06/13] Attributes content --- docs/_templates/product-v2.rst | 2 +- docs/data/product/dea-coastlines/_tables.yaml | 76 ++++--------------- 2 files changed, 17 insertions(+), 61 deletions(-) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index 688cdab44..ee0969d50 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -538,7 +538,7 @@ {% for layer in layers_table_list %} * - **{{ layer.name }}** - - {{ layer.description or no_data_terms.dash }} This layer contains the following attributes. + - {{ layer.description or no_data_terms.dash }} Attribute fields: {% for attribute in layer.attributes %} * **{{ attribute.name }}** :raw-html:`—` {{ attribute.description }} diff --git a/docs/data/product/dea-coastlines/_tables.yaml b/docs/data/product/dea-coastlines/_tables.yaml index 1c8d3488e..6cb59e064 100644 --- a/docs/data/product/dea-coastlines/_tables.yaml +++ b/docs/data/product/dea-coastlines/_tables.yaml @@ -11,7 +11,7 @@ layers_table: - name: year description: The year of each annual shoreline. - name: certainty - description: A column providing important data quality flags for each annual shoreline. + description: A column providing important data quality flags for each annual shoreline. For more information, see the `Quality tab <./?tab=quality>`_. - name: tide_datum description: The tide datum of each annual shoreline (e.g. “0 m AMSL”). - name: id_primary @@ -21,76 +21,32 @@ layers_table: description: A point dataset providing robust rates of coastal change for every 30 m along Australia’s non-rocky coastlines. attributes: - name: uid - description: + description: A unique geohash identifier for each point. - name: rate_time - description: + description: Annual rates of change (in metres per year) calculated by linearly regressing annual shoreline distances against time (excluding outliers). Negative values indicate retreat and positive values indicate growth. - name: sig_time - description: + description: Significance (p-value) of the linear relationship between annual shoreline distances and time. Small values (e.g. p-value < 0.01 or 0.05) may indicate a coastline is undergoing consistent coastal change through time. - name: se_time - description: + description: Standard error (in metres) of the linear relationship between annual shoreline distances and time. This can be used to generate confidence intervals around the rate of change given by ``rate_time``, e.g. :math:`\text{95% confidence interval} = \text{se_time} \times 1.96` - name: outl_time - description: + description: Individual annual shoreline are noisy estimators of coastline position that can be influenced by environmental conditions (e.g. clouds, breaking waves, sea spray) or modelling issues (e.g. poor tidal modelling results or limited clear satellite observations). To obtain reliable rates of change, outlier shorelines are excluded using a robust Median Absolute Deviation outlier detection algorithm, and recorded in this column. - name: dist_1990, dist_1991, etc - description: + description: Annual shoreline distances (in metres) relative to the most recent baseline shoreline. Negative values indicate that an annual shoreline was located inland of the baseline shoreline. By definition, the most recent baseline column will always have a distance of 0 m. - name: angle_std - description: + description: The mean angle and standard deviation between the baseline point to all annual shorelines. This data is used to calculate how well shorelines fall along a consistent line; high angular standard deviation indicates that derived rates of change are unlikely to be correct. - name: valid_obs - description: + description: The total number of valid (i.e. non-outliers, non-missing) annual shoreline observations, and the maximum number of years between the first and last valid annual shoreline. - name: valid_span - description: + description: The total number of valid (i.e. non-outliers, non-missing) annual shoreline observations, and the maximum number of years between the first and last valid annual shoreline. - name: sce - description: + description: Shoreline Change Envelope (SCE). A measure of the maximum change or variability across all annual shorelines, calculated by computing the maximum distance between any two annual shorelines (excluding outliers). This statistic excludes sub-annual shoreline variability. - name: nsm - description: + description: Net Shoreline Movement (NSM). The distance between the oldest (1988) and most recent annual shoreline (excluding outliers). Negative values indicate the coastline retreated between the oldest and most recent shoreline; positive values indicate growth. This statistic does not reflect sub-annual shoreline variability, so will underestimate the full extent of variability at any given location. - name: max_year - description: + description: The year that annual shorelines were at their maximum (i.e. located furthest towards the ocean), excluding outliers. This statistic excludes sub-annual shoreline variability. - name: min_year - description: + description: The year that annual shorelines were at their minimum (i.e. located furthest inland), excluding outliers. This statistic excludes sub-annual shoreline variability. - name: certainty - description: + description: A column providing important data quality flags for each point in the dataset. For more information, see the `Quality tab <./?tab=quality>`_. - name: id_primary - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: - - name: - description: + description: The name of the annual shoreline’s Primary sediment compartment from the `Australian Coastal Sediment Compartments `_ framework. From bb0ff86851e14c0ef25d3595764f38a7974f7978 Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Fri, 3 Jan 2025 10:29:50 +1100 Subject: [PATCH 07/13] Added layers summary row --- docs/_templates/product-v2.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index ee0969d50..039e7a0c8 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -372,6 +372,16 @@ * - **Bands** - `Single band of data ({{ bands_table_list[0].name }}) <./?tab=specifications>`_ {%- endif %} + {% if layers_table_list and layers_count >= 3 %} + * - **Layers** + - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }}, {{ layers_table_list[1].name }}, and more) <./?tab=specifications>`_ + {%- elif layers_table_list and layers_count == 2 %} + * - **Layers** + - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }} and {{ layers_table_list[1].name }}) <./?tab=specifications>`_ + {%- elif layers_table_list and layers_count == 1 %} + * - **Layers** + - `Single layer of data ({{ layers_table_list[0].name }}) <./?tab=specifications>`_ + {%- endif %} {%- if page.data.doi %} * - **DOI** - `{{ page.data.doi }} `_ From f2cce57dccb8816e46c42dccea2443de51402c43 Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Fri, 3 Jan 2025 10:34:39 +1100 Subject: [PATCH 08/13] Wording of the layers summary --- docs/_templates/product-v2.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index 039e7a0c8..fa3c8fe86 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -374,13 +374,13 @@ {%- endif %} {% if layers_table_list and layers_count >= 3 %} * - **Layers** - - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }}, {{ layers_table_list[1].name }}, and more) <./?tab=specifications>`_ - {%- elif layers_table_list and layers_count == 2 %} - * - **Layers** - - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }} and {{ layers_table_list[1].name }}) <./?tab=specifications>`_ - {%- elif layers_table_list and layers_count == 1 %} - * - **Layers** - - `Single layer of data ({{ layers_table_list[0].name }}) <./?tab=specifications>`_ + - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }}, {{ layers_table_list[1].name }}, and more). See attribute fields of these layers. <./?tab=specifications>`_ + {%- elif layers_table_list and layers_count == 2 %} + * - **Layers** + - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }} and {{ layers_table_list[1].name }}). See attribute fields of these layers. <./?tab=specifications>`_ + {%- elif layers_table_list and layers_count == 1 %} + * - **Layers** + - `Single layer of data ({{ layers_table_list[0].name }}). See attribute fields of this layer. <./?tab=specifications>`_ {%- endif %} {%- if page.data.doi %} * - **DOI** From 50805130c23d78f4b5673de128200498609ebe51 Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Fri, 3 Jan 2025 10:43:23 +1100 Subject: [PATCH 09/13] Reformatting the layers table --- docs/_templates/product-v2.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index fa3c8fe86..ec07cd30b 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -547,12 +547,17 @@ :name: layers-table {% for layer in layers_table_list %} - * - **{{ layer.name }}** - - {{ layer.description or no_data_terms.dash }} Attribute fields: + **{{ layer.name }}** - {% for attribute in layer.attributes %} - * **{{ attribute.name }}** :raw-html:`—` {{ attribute.description }} - {% endfor %} + {{ layer.description or no_data_terms.dash }} Attribute fields: + + .. list-table:: + :name: layers-table + + {% for attribute in layer.attributes %} + * - **{{ attribute.name }}** + - {{ attribute.description }} + {% endfor %} {% endfor %} {{ page.tables.layers_footnote if page.tables.layers_footnote }} From 989cc9b3f0c3abbc5bc4566303f5b9131efa75cf Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Fri, 3 Jan 2025 10:45:33 +1100 Subject: [PATCH 10/13] Rewording summary --- docs/_templates/product-v2.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index ec07cd30b..5ff68d872 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -374,13 +374,13 @@ {%- endif %} {% if layers_table_list and layers_count >= 3 %} * - **Layers** - - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }}, {{ layers_table_list[1].name }}, and more). See attribute fields of these layers. <./?tab=specifications>`_ + - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }}, {{ layers_table_list[1].name }}, and more). View their attribute fields. <./?tab=specifications>`_ {%- elif layers_table_list and layers_count == 2 %} * - **Layers** - - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }} and {{ layers_table_list[1].name }}). See attribute fields of these layers. <./?tab=specifications>`_ + - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }} and {{ layers_table_list[1].name }}). View their attribute fields. <./?tab=specifications>`_ {%- elif layers_table_list and layers_count == 1 %} * - **Layers** - - `Single layer of data ({{ layers_table_list[0].name }}). See attribute fields of this layer. <./?tab=specifications>`_ + - `Single layer of data ({{ layers_table_list[0].name }}). View attribute fields. <./?tab=specifications>`_ {%- endif %} {%- if page.data.doi %} * - **DOI** From 53d0bcfe64a2f41c7a6a275bc4865cbcb684e34e Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Fri, 3 Jan 2025 10:48:44 +1100 Subject: [PATCH 11/13] Added layers table to starter kit --- starter-kits/product/_tables.yaml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/starter-kits/product/_tables.yaml b/starter-kits/product/_tables.yaml index 0a8e33157..f53e5a2f4 100644 --- a/starter-kits/product/_tables.yaml +++ b/starter-kits/product/_tables.yaml @@ -13,3 +13,13 @@ # type: int16 # description: A description of the band. +# Layers + +# layers_footnote: A footnote to display under the layers table. + +# layers_table: +# - name: example_layer_name +# description: A description of the layer. +# attributes: +# - name: example_attribute_name +# description: A description of the attribute. From 9d0ae2cb4a89578aa697818b7c23ed793c1d8559 Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Fri, 3 Jan 2025 11:00:46 +1100 Subject: [PATCH 12/13] RST table fix --- docs/_templates/product-v2.rst | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index 5ff68d872..955fe7c88 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -543,22 +543,19 @@ This product contains the following layers and attribute fields. - .. list-table:: - :name: layers-table - - {% for layer in layers_table_list %} - **{{ layer.name }}** + {% for layer in layers_table_list %} + **{{ layer.name }}** - {{ layer.description or no_data_terms.dash }} Attribute fields: + {{ layer.description or no_data_terms.dash }} Attribute fields: - .. list-table:: - :name: layers-table + .. list-table:: + :name: layers-table - {% for attribute in layer.attributes %} - * - **{{ attribute.name }}** - - {{ attribute.description }} - {% endfor %} + {% for attribute in layer.attributes %} + * - **{{ attribute.name }}** + - {{ attribute.description }} {% endfor %} + {% endfor %} {{ page.tables.layers_footnote if page.tables.layers_footnote }} From 0694091e1d8b880d40eeca85eb55d592e1da3bc4 Mon Sep 17 00:00:00 2001 From: Benjamin Glitsos Date: Fri, 3 Jan 2025 11:58:41 +1100 Subject: [PATCH 13/13] Minor formatting of vector layers --- docs/_templates/product-v2.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index 955fe7c88..1ca03aa23 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -541,10 +541,10 @@ :name: layers :class: h2 - This product contains the following layers and attribute fields. + This product contains the following layers, and the attribute fields of each are listed. {% for layer in layers_table_list %} - **{{ layer.name }}** + **Layer: {{ layer.name }}** {{ layer.description or no_data_terms.dash }} Attribute fields: