Fixing the GX API page after transition from autogenerated-index to o…

…rdinary doc page
great-expectations · Mar 12, 2024 · ab04304 · ab04304
1 parent 09bf632
commit ab04304
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 13 deletions.
diff --git a/..._docs/version-0.18/reference/api/index.md → docs/docusaurus/docs/reference/index.md b/..._docs/version-0.18/reference/api/index.md → docs/docusaurus/docs/reference/index.md
diff --git a/docs/docusaurus/docusaurus.config.js b/docs/docusaurus/docusaurus.config.js
@@ -146,7 +146,7 @@ module.exports = {
         {
           type: 'doc',
           label: 'GX API',
-          docId: 'reference/api/index',
+          docId: 'reference/index',
           position: 'right',
         },
         {

diff --git a/docs/docusaurus/sidebars.js b/docs/docusaurus/sidebars.js
@@ -605,10 +605,8 @@ module.exports = {
       type: 'category',
       label: 'GX API',
       link: {
-        type: 'generated-index',
-        title: 'GX API',
-        description: 'GX API reference content is generated from classes and methods docstrings.',
-        slug: '/reference/api/'
+        type: 'doc',
+        id: 'reference/index'
       },
       items: [
         {

diff --git a/docs/docusaurus/src/css/breadcrumbs.scss b/docs/docusaurus/src/css/breadcrumbs.scss
@@ -12,3 +12,7 @@
     color: var(--link-hover-color);
   }
 }
+
+.breadcrumbs:has(li:only-child) {
+  display: none;
+}
diff --git a/docs/docusaurus/src/css/overview_pages.scss b/docs/docusaurus/src/css/overview_pages.scss
@@ -39,10 +39,6 @@
 }
 
 .generated-index-page {
-  .theme-doc-breadcrumbs {
-    display: none;
-  }
-
   & > div {
     max-width: unset !important;
   }

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/index.md b/docs/docusaurus/versioned_docs/version-0.18/reference/index.md
@@ -0,0 +1,15 @@
+---
+title: 'GX API'
+hide_title: true
+hide_table_of_contents: true
+pagination_next: null
+pagination_prev: null
+hide_feedback_survey: true
+---
+import OverviewCard from '@site/src/components/OverviewCard';
+import DocCardList from '@theme/DocCardList';
+
+<OverviewCard title={frontMatter.title}>
+  GX API reference content is generated from classes and methods docstrings.
+</OverviewCard>
+<DocCardList/>
diff --git a/docs/docusaurus/versioned_sidebars/version-0.18-sidebars.json b/docs/docusaurus/versioned_sidebars/version-0.18-sidebars.json
@@ -524,10 +524,8 @@
       "type": "category",
       "label": "GX API",
       "link": {
-        "type": "generated-index",
-        "title": "GX API",
-        "description": "GX API reference content is generated from classes and methods docstrings.",
-        "slug": "/reference/api/"
+        "type": "doc",
+        "id": "version-0.18/reference/index"
       },
       "items": [
         {