From 46e7ce64bc5b86f9cfb654c75a3299137f1f4703 Mon Sep 17 00:00:00 2001
From: Oscar Gustafsson <oscar.gustafsson@gmail.com>
Date: Mon, 8 May 2023 20:54:36 +0200
Subject: [PATCH] Improve docs
---
b_asic/architecture.py | 4 ++--
docs_sphinx/api/architecture.rst | 1 +
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/b_asic/architecture.py b/b_asic/architecture.py
index 730e7b66..d8054543 100644
--- a/b_asic/architecture.py
+++ b/b_asic/architecture.py
@@ -84,7 +84,7 @@ class Resource(HardwareBlock):
Parameters
----------
- process_collection : ProcessCollection
+ process_collection : :class:`~b_asic.resources.ProcessCollection`
The process collection containing processes to be mapped to resource.
entity_name : str, optional
The name of the resulting entity.
@@ -247,7 +247,7 @@ class Architecture(HardwareBlock):
----------
processing_elements : :class:`~b_asic.architecture.ProcessingElement` or iterable of :class:`~b_asic.architecture.ProcessingElement`
The processing elements in the architecture.
- memories : `~b_asic.architecture.Memory` or iterable of :class:`~b_asic.architecture.Memory`
+ memories : :class:`~b_asic.architecture.Memory` or iterable of :class:`~b_asic.architecture.Memory`
The memories in the architecture.
entity_name : str, default: "arch"
Name for the top-level entity.
diff --git a/docs_sphinx/api/architecture.rst b/docs_sphinx/api/architecture.rst
index 9e821817..d29a1b19 100644
--- a/docs_sphinx/api/architecture.rst
+++ b/docs_sphinx/api/architecture.rst
@@ -9,3 +9,4 @@
.. automodule:: b_asic.architecture
:members:
:undoc-members:
+ :inherited-members:
--
GitLab