Merge pull request #311 from mit-ll-responsible-ai/remove-sphinx-tabs

remove sphinx-tabs in favor of sphinx-design (fixes dark-theme tabs)
mit-ll-responsible-ai · Sep 29, 2022 · 8e46b85 · 8e46b85
2 parents 33bb4a1 + ce491ad
commit 8e46b85
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,7 +2,7 @@ sphinx==5.1.1
 pydata-sphinx-theme==0.10.1
 numpydoc==1.4.0
 sphinx-copybutton==0.5.0
-sphinx-tabs==3.4.1
+sphinx-design==0.3.0
 sphinx-codeautolink==0.11.0
 # third-party utilities
 beartype==0.8.1

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -42,7 +42,7 @@
     "sphinx.ext.autosummary",
     "numpydoc",
     "sphinx_copybutton",
-    "sphinx_tabs.tabs",
+    "sphinx_design",
     "sphinx_codeautolink",
 ]
 

diff --git a/docs/source/explanation/dont_repeat_yourself.rst b/docs/source/explanation/dont_repeat_yourself.rst
@@ -39,9 +39,10 @@ Statically-Defined Configs are WET
 
 Manually writing a structured config for ``DNN`` entails hard-coding its current import-path as a string as wll as explicitly mirroring its signature:
 
-.. tabs::
 
-   .. tab:: dataclass-based config
+.. tab-set::
+
+   .. tab-item:: dataclass-based config
 
       .. code-block:: python
          :caption: Manually configuring ``DNN`` with a dataclass
@@ -56,7 +57,7 @@ Manually writing a structured config for ``DNN`` entails hard-coding its current
              device: str = "cpu"
              _target_: str = "vision.model.DNN"
 
-   .. tab:: yaml-based config
+   .. tab-item:: yaml-based config
 
       .. code-block:: yaml
          :caption: Manually configuring ``DNN`` with a YAML file