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: diff --git a/docs/conf.py b/docs/conf.py index f27cce85..060f14df 100644 --- a/docs/conf.py +++ b/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.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: