Skip to content

Add inheritance graphs to docs #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 15, 2023
Merged

Add inheritance graphs to docs #171

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d5a8902
Enable inheritance diagrams
dstansby Jun 15, 2023
710d9f8
Make diagrams vertical
dstansby Jun 15, 2023
c27c089
Install graphviz in doc build
dstansby Jun 15, 2023
723550b
Update nitpick ignores
dstansby Jun 15, 2023
26c8bd0
Fix spelling error
dstansby Jun 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 6 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand All @@ -63,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.
Expand Down