Skip to content

Commit 14497ba

Browse files
committed
Revert "Remove inheritence diagrams from docs. readthedocs no longer has dot installed"
This reverts commit c862db2.
1 parent c862db2 commit 14497ba

File tree

6 files changed

+20
-10
lines changed

6 files changed

+20
-10
lines changed

.readthedocs.yaml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ sphinx:
1313
python:
1414
install:
1515
- requirements: docs/requirements.txt
16-
- requirements: requirements.txt
16+
- method: pip
17+
path: .
18+
19+
20+
build:
21+
apt_packages:
22+
- graphviz

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
extensions = [
3232
'sphinx.ext.autodoc',
3333
'sphinx.ext.napoleon',
34+
'sphinx.ext.inheritance_diagram',
3435
'crate.sphinx.csv',
3536
]
3637

requirements.txt

Lines changed: 0 additions & 3 deletions
This file was deleted.

setup.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,6 @@
1818
exec(f.read(), v_dict)
1919
rdl_version = v_dict['__version__']
2020

21-
def parse_requirements(filename):
22-
lineiter = (line.strip() for line in open(filename))
23-
reqs = [line for line in lineiter if line and not line.startswith("#")]
24-
return reqs
25-
2621
target = platform.system().lower()
2722
PLATFORMS = {'windows', 'linux', 'darwin', 'cygwin'}
2823
for known in PLATFORMS:
@@ -71,7 +66,11 @@ def run_setup(with_binary):
7166
ext_modules=ext_modules,
7267
cmdclass={"build_ext": ve_build_ext},
7368
python_requires='>=3.5.2',
74-
install_requires=parse_requirements("requirements.txt"),
69+
install_requires=[
70+
"antlr4-python3-runtime >= 4.11, < 4.14",
71+
"colorama",
72+
"markdown",
73+
],
7574
classifiers=[
7675
"Development Status :: 5 - Production/Stable",
7776
"Programming Language :: Python",

systemrdl/component.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
class Component:
1515
"""
1616
Base class for all component types
17+
18+
.. inheritance-diagram:: systemrdl.component
19+
:top-classes: ~Component
1720
"""
1821

1922
def __init__(self) -> None:

systemrdl/node.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ class Node:
1616
"""
1717
The Node object is a higher-level overlay that provides a more user-friendly
1818
interface to query the compiled RDL object model.
19+
20+
.. inheritance-diagram:: systemrdl.node
21+
:top-classes: ~Node
22+
1923
"""
2024

2125
def __init__(self, inst: comp.Component, env: 'RDLEnvironment', parent: Optional['Node']):

0 commit comments

Comments
 (0)