docs: mark deprecated items in module template

ReactiveX · Dec 15, 2022 · 6208865 · 6208865
1 parent 5df07eb
commit 6208865
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 73 deletions.
diff --git a/docs_app/src/styles/1-layouts/_api-page.scss b/docs_app/src/styles/1-layouts/_api-page.scss
@@ -1,88 +1,93 @@
 .api-section {
-    position: relative;
-
-    pre {
-        white-space: pre-wrap;
+  position: relative;
+
+  pre {
+    white-space: pre-wrap;
+  }
+
+  table.api-table {
+    min-width: 680px;
+
+    thead th {
+      color: white;
+      font-size: 16px;
+      background-color: $pink;
+      border-radius: 4px 4px 0 0;
+      text-transform: none;
+      padding: 8px 24px;
     }
 
-    table.api-table {
-        min-width: 680px;
-
-        thead th {
-            color: white;
-            font-size: 16px;
-            background-color: $pink;
-            border-radius: 4px 4px 0 0;
-            text-transform: none;
-            padding: 8px 24px;
-        }
-
-        tbody {
-            pre {
-                white-space: normal;
-                margin: 4px;
-                padding: 4px 16px;
-            }
-
-            td, th {
-                padding: 0;
-            }
-
-            th {
-                max-width: 150px;
-            }
-        }
-
+    tbody {
+      pre {
+        white-space: normal;
+        margin: 4px;
+        padding: 4px 16px;
+      }
+
+      td,
+      th {
+        padding: 0;
+      }
+
+      th {
+        max-width: 150px;
+      }
     }
+  }
 }
 
 .api-body {
+  max-width: 1200px;
 
-    max-width: 1200px;
-
-    table {
-
-        th {
-            text-transform: none;
-            font-size: 16px;
-            font-weight: bold;
-        }
-
-        tr {
-            border-bottom: 1px solid $lightgray;
-        }
-
-        td {
-            vertical-align: middle;
-        }
+  table {
+    th {
+      text-transform: none;
+      font-size: 16px;
+      font-weight: bold;
+    }
 
-        hr {
-            margin: 16px 0;
-        }
+    tr {
+      border-bottom: 1px solid $lightgray;
+    }
 
-        tr:last-child {
-            border-bottom: none;
-        }
+    td {
+      vertical-align: middle;
+    }
 
-        &.item-table {
-            td {
-                padding: 32px;
-            }
-        }
+    hr {
+      margin: 16px 0;
+    }
 
-        &.list-table {
-            td {
-                padding: 16px 24px;
-            }
-        }
+    tr:last-child {
+      border-bottom: none;
     }
 
-    /* used to target the short description */
-    > p:nth-child(2) {
-        border-left: 5px solid $pink;
-        font-size: 1rem;
-        line-height: 1.25;
-        padding-left: .5rem;
+    &.item-table {
+      td {
+        padding: 32px;
+      }
+    }
 
+    &.list-table {
+      td {
+        padding: 16px 24px;
+      }
+    }
+  }
+
+  /* used to target the short description */
+  > p:nth-child(2) {
+    border-left: 5px solid $pink;
+    font-size: 1rem;
+    line-height: 1.25;
+    padding-left: 0.5rem;
+  }
+
+  .export-list {
+    a {
+      &.deprecated {
+        text-decoration: line-through;
+      }
     }
-}
+  }
+}
diff --git a/docs_app/tools/transforms/templates/api/module.template.html b/docs_app/tools/transforms/templates/api/module.template.html
@@ -9,7 +9,7 @@
   <ul>
     {% for export in doc.exports -%}
       {% if not export.duplicateOf %}
-        <li><a href="{$ export.path $}">{$ export.name $}</a></li>
+        <li><a{% if export.deprecated %} class="deprecated"{% endif %} href="{$ export.path $}">{$ export.name $}</a></li>
       {% endif %}
     {%- endfor %}
   </ul>