Add sphinx-tabs for documentation generation with tabs

Karel-van-de-Plassche · Karel-van-de-Plassche · commit 501b342b0db5 · 2023-05-16T17:03:58.000+02:00
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -123,6 +123,7 @@
     "recommonmark",  # For markdown support, does not support 'full' CommonMark syntax (yet)!
     "sphinx_autodoc_typehints",  # Auto-parse type hints. Napoleon BEFORE typehints
     "sphinxcontrib.mermaid",  # Draw graphs using Mermaid.js
+    "sphinx_tabs.tabs", # Toggleable HTML tabs
 ]
 
 todo_include_todos = True
diff --git a/pyproject.toml b/pyproject.toml
@@ -72,7 +72,8 @@ docs = [
     "recommonmark>=0.6",
     "sphinx-autosummary-accessors>=0.1.2",
     "sphinx-autodoc-typehints>=1.1.1",
-    "sphinxcontrib.mermaid>=0.8"
+    "sphinxcontrib.mermaid>=0.8",
+    "sphinx-tabs",
 ]
 test = [
     "pytest>=5.4.1",

Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,7 @@`
`123`	`123`	`"recommonmark", # For markdown support, does not support 'full' CommonMark syntax (yet)!`
`124`	`124`	`"sphinx_autodoc_typehints", # Auto-parse type hints. Napoleon BEFORE typehints`
`125`	`125`	`"sphinxcontrib.mermaid", # Draw graphs using Mermaid.js`
	`126`	`+ "sphinx_tabs.tabs", # Toggleable HTML tabs`
`126`	`127`	`]`
`127`	`128`
`128`	`129`	`todo_include_todos = True`