Merge pull request #2 from FoamyGuy/docs_diagram

kmatch98 · web-flow · commit 9a2f613cad93 · 2021-05-01T21:19:58.000-05:00
adding inheritance diagram to docs
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -45,6 +45,9 @@ jobs:
     - name: Pip install pylint, Sphinx, pre-commit
       run: |
         pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit
+    - name: Load graphviz
+      run: |
+        sudo apt install graphviz
     - name: Library version
       run: git describe --dirty --always --tags
     - name: Setup problem matchers
diff --git a/docs/api.rst b/docs/api.rst
@@ -7,3 +7,6 @@
 .. automodule:: displayio_switchround
     :members:
     :member-order: bysource
+    :inherited-members:
+
+.. inheritance-diagram:: adafruit_displayio_layout.widgets.switch_round
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,6 +19,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
+    "sphinx.ext.inheritance_diagram",
 ]
 
 # TODO: Please Read!

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`"sphinx.ext.intersphinx",`
`20`	`20`	`"sphinx.ext.napoleon",`
`21`	`21`	`"sphinx.ext.todo",`
	`22`	`+ "sphinx.ext.inheritance_diagram",`
`22`	`23`	`]`
`23`	`24`
`24`	`25`	`# TODO: Please Read!`