From d5a890249867d202a39ceb8765259b811817113a Mon Sep 17 00:00:00 2001
From: David Stansby <dstansby@gmail.com>
Date: Thu, 15 Jun 2023 09:56:54 +0100
Subject: [PATCH 1/5] Enable inheritance diagrams
---
docs/conf.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/conf.py b/docs/conf.py
index f27cce85..badc9432 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -49,7 +49,7 @@
}
numpydoc_show_class_members = False
-automodapi_inheritance_diagram = False
+automodapi_inheritance_diagram = True
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
From 710d9f8f62c22b7d9d389957dd02bbc07a4d263c Mon Sep 17 00:00:00 2001
From: David Stansby <dstansby@gmail.com>
Date: Thu, 15 Jun 2023 10:00:21 +0100
Subject: [PATCH 2/5] Make diagrams vertical
---
docs/conf.py | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/conf.py b/docs/conf.py
index badc9432..86b14858 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -50,6 +50,7 @@
numpydoc_show_class_members = False
automodapi_inheritance_diagram = True
+inheritance_graph_attrs = {"rankdir": "TR"}
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
From c27c089e49901d58662effb09e32e9fb2cbff399 Mon Sep 17 00:00:00 2001
From: David Stansby <dstansby@gmail.com>
Date: Thu, 15 Jun 2023 10:05:29 +0100
Subject: [PATCH 3/5] Install graphviz in doc build
---
.github/workflows/docs.yml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 50d37fe7..e8c7acb2 100644
--- a/.github/workflows/docs.yml
+++ b/.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:
From 723550bafd5225da2d1a1c4e3763bff57fa8ecc7 Mon Sep 17 00:00:00 2001
From: David Stansby <dstansby@gmail.com>
Date: Thu, 15 Jun 2023 10:29:32 +0100
Subject: [PATCH 4/5] Update nitpick ignores
---
docs/conf.py | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/conf.py b/docs/conf.py
index 86b14858..25055a3d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -64,8 +64,11 @@
# Can't work out how to link this properley 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.
From 26c8bd09d0c89dd5cb372602ab58c6f1c5facc86 Mon Sep 17 00:00:00 2001
From: David Stansby <dstansby@gmail.com>
Date: Thu, 15 Jun 2023 10:38:04 +0100
Subject: [PATCH 5/5] Fix spelling error
Co-authored-by: Sam Cunliffe <samcunliffe@users.noreply.github.com>
---
docs/conf.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/conf.py b/docs/conf.py
index 25055a3d..060f14df 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -61,7 +61,7 @@
}
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", "PyQt5.QtWidgets.QWidget"),