bugfix: update ipynb

Author: EdenWuyifan

docs/requirements.txt

@@ -1,2 +1,3 @@
 sphinx==7.1.2
 sphinx-rtd-theme==1.3.0rc1
+nbsphinx

docs/source/api.rst

@@ -1,7 +1,7 @@
 API
 ===
 
-.. module:: bdiviz.api
+.. module:: bdiviz
 
 .. autoclass:: BDISchemaMatchingHeatMap
    :members:

docs/source/conf.py

@@ -1,5 +1,10 @@
 # Configuration file for the Sphinx documentation builder.
 
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../../'))
+
 # -- Project information
 
 project = 'BDI-Viz'
@@ -17,6 +22,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    "nbsphinx",
 ]
 
 intersphinx_mapping = {
@@ -33,3 +39,11 @@
 
 # -- Options for EPUB output
 epub_show_urls = 'footnote'
+
+autodoc_member_order = 'bysource'
+
+autoclass_content = 'both'
+
+add_module_names = False
+
+autodoc_mock_imports = ['altair', 'bdi-kit', 'bokeh', 'datamart_profiler', 'panel', 'pandas', 'numpy']

docs/source/getting-started.ipynb

@@ -3484,7 +3484,7 @@
    "source": [
     "## Prepare the source and target dataframes\n",
     "\n",
-    "The only step before using the `BDISchemaMatchingHeatMap` class is to prepare the source and target dataframes. The source and target should be in the form of pandas dataframes. For [`GDC`](https://gdc.cancer.gov/) data, we can simply pass `\"gdc\"` as target schema. In this example, we will use the `GDC` schema as the target schema and a sample schema as the source schema."
+    "The only step before using the `BDISchemaMatchingHeatMap` class is to prepare the source and target dataframes. The source and target should be in the form of pandas dataframes. For [**GDC**](https://gdc.cancer.gov/) data, we can simply pass `\"gdc\"` as target schema. In this example, we will use the `GDC` schema as the target schema and a sample schema as the source schema."
    ]
   },
   {
@@ -3657,6 +3657,13 @@
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
    "version": "3.9.6"
+  },
+  "widgets": {
+   "application/vnd.jupyter.widget-state+json": {
+    "state": {},
+    "version_major": 2,
+    "version_minor": 0
+   }
   }
  },
  "nbformat": 4,