docs(distrib): generate entries of submodule *distrib*

BAMresearch · Feb 24, 2023 · c8055c6 · c8055c6
1 parent 762a548
commit c8055c6
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,7 +32,7 @@
 release = version
 commit_id = subprocess.check_output(['git', 'rev-parse', '--short', 'HEAD']).strip().decode('ascii')
 
-autodoc_mock_imports = ["ipykernel", "notebook", "pandas", "ipywidgets"]
+autodoc_mock_imports = ["ipykernel", "notebook", "pandas", "ipywidgets", "matplotlib", "scipy"]
 
 pygments_style = 'trac'
 templates_path = ['.']

diff --git a/docs/reference/jupyter_analysis_tools.distrib.rst b/docs/reference/jupyter_analysis_tools.distrib.rst
@@ -0,0 +1,5 @@
+jupyter_analysis_tools.distrib
+==============================
+
+.. automodule:: jupyter_analysis_tools.distrib
+    :members:
diff --git a/src/jupyter_analysis_tools/plotting.py b/src/jupyter_analysis_tools/plotting.py
@@ -4,8 +4,11 @@
 import matplotlib
 import matplotlib.pyplot as plt
 
-# increase the limit for the warning to pop up
-matplotlib.rcParams['figure.max_open_warning'] = 50
+try:
+    # increase the limit for the warning to pop up
+    matplotlib.rcParams['figure.max_open_warning'] = 50
+except TypeError:  # ignore the error with Sphinx
+    pass
 
 
 def initFigure(fig, width=80, aspectRatio=4.0 / 3.0, quiet=False):