Merge pull request #171 from dstansby/inheritance-graphs

Add inheritance graphs to docs

Author: dstansby

Diff for: .github/workflows/docs.yml

@@ -22,6 +22,8 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install ".[docs]"
+          sudo apt install graphviz --yes
+
       - name: Build Docs
         uses: aganders3/headless-gui@v1
         with:

Diff for: docs/conf.py

@@ -49,7 +49,8 @@
 }
 
 numpydoc_show_class_members = False
-automodapi_inheritance_diagram = False
+automodapi_inheritance_diagram = True
+inheritance_graph_attrs = {"rankdir": "TR"}
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
@@ -60,11 +61,14 @@
 }
 
 nitpicky = True
-# Can't work out how to link this properley using intersphinx and the PyQT6 docs.
+# Can't work out how to link this properly using intersphinx and the PyQT6 docs.
 # TODO: fix at some point
 nitpick_ignore = [
-    ("py:class", "PyQt6.QtWidgets.QWidget"),
     ("py:class", "PyQt5.QtWidgets.QWidget"),
+    ("py:class", "PyQt5.QtCore.QObject"),
+    ("py:class", "PyQt5.QtGui.QPaintDevice"),
+    ("py:class", "sip.simplewrapper"),
+    ("py:class", "sip.wrapper"),
 ]
 
 # Add any paths that contain templates here, relative to this directory.