Revert "Remove inheritence diagrams from docs. readthedocs no longer …

…has dot installed" This reverts commit c862db2.
SystemRDL · Oct 12, 2023 · 14497ba · 14497ba
1 parent c862db2
commit 14497ba
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 10 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -13,4 +13,10 @@ sphinx:
 python:
   install:
     - requirements: docs/requirements.txt
-    - requirements: requirements.txt
+    - method: pip
+      path: .
+
+
+build:
+  apt_packages:
+    - graphviz
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,6 +31,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
+    'sphinx.ext.inheritance_diagram',
     'crate.sphinx.csv',
 ]
 

diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.py b/setup.py
@@ -18,11 +18,6 @@
     exec(f.read(), v_dict)
     rdl_version = v_dict['__version__']
 
-def parse_requirements(filename):
-    lineiter = (line.strip() for line in open(filename))
-    reqs = [line for line in lineiter if line and not line.startswith("#")]
-    return reqs
-
 target = platform.system().lower()
 PLATFORMS = {'windows', 'linux', 'darwin', 'cygwin'}
 for known in PLATFORMS:
@@ -71,7 +66,11 @@ def run_setup(with_binary):
         ext_modules=ext_modules,
         cmdclass={"build_ext": ve_build_ext},
         python_requires='>=3.5.2',
-        install_requires=parse_requirements("requirements.txt"),
+        install_requires=[
+            "antlr4-python3-runtime >= 4.11, < 4.14",
+            "colorama",
+            "markdown",
+        ],
         classifiers=[
             "Development Status :: 5 - Production/Stable",
             "Programming Language :: Python",

diff --git a/systemrdl/component.py b/systemrdl/component.py
@@ -14,6 +14,9 @@
 class Component:
     """
     Base class for all component types
+
+    .. inheritance-diagram:: systemrdl.component
+        :top-classes: ~Component
     """
 
     def __init__(self) -> None:

diff --git a/systemrdl/node.py b/systemrdl/node.py
@@ -16,6 +16,10 @@ class Node:
     """
     The Node object is a higher-level overlay that provides a more user-friendly
     interface to query the compiled RDL object model.
+
+    .. inheritance-diagram:: systemrdl.node
+        :top-classes: ~Node
+
     """
 
     def __init__(self, inst: comp.Component, env: 'RDLEnvironment', parent: Optional['Node']):