Skip to content

Commit 3594565

Browse files
committed
Improved diagrams.
1 parent 3d49855 commit 3594565

File tree

6 files changed

+72
-72
lines changed

6 files changed

+72
-72
lines changed

doc/FileTypes/index.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ Content Types
1313
.. mermaid::
1414

1515
graph TD;
16-
HumanReadableContent-->XMLContent;
17-
HumanReadableContent-->YAMLContent;
18-
HumanReadableContent-->JSONContent;
19-
HumanReadableContent-->INIContent;
20-
HumanReadableContent-->TOMLContent;
21-
HumanReadableContent-->TCLContent-->SDCContent;
16+
HRC[HumanReadableContent] --> XMLC[XMLContent];
17+
HRC --> YAMLC[YAMLContent];
18+
HRC --> JSONC[JSONContent];
19+
HRC --> INIC[INIContent];
20+
HRC --> TOMLC[TOMLContent];
21+
HRC --> TCLC[TCLContent] --> SDCC[SDCContent];
2222

2323

2424
Overall Hierarchy
@@ -30,7 +30,7 @@ Overall Hierarchy
3030
File-->TextFile;
3131
File-->LogFile;
3232
File-->XMLFile;
33-
File-->SourceFile;
33+
File--->SourceFile;
3434
File-->ConstraintFile;
3535
File-->ProjectFile;
3636
File-->SettingFile;

doc/ProjectModel/Design.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ Design
55

66
Generic description of an EDA design.
77

8-
.. rubric:: Table of Content
9-
10-
* :ref:`projectmodel-design2`
8+
.. todo::
119

10+
Write documentation.
1211

13-
.. rubric:: Class Hierarchy
1412

15-
.. inheritance-diagram:: pyEDAA.ProjectModel.Design
16-
:parts: 1
13+
.. rubric:: Class Relationship
1714

15+
.. mermaid::
1816

19-
.. _projectmodel-design2:
17+
graph TD;
18+
Project --> Design;
19+
Design --> VHDLLibrary;
20+
Design --> FileSet;
21+
VHDLLibrary --> File;
22+
FileSet --> File
2023

21-
Design
22-
======
24+
style Design fill:#ee9b00
2325

24-
.. todo::
25-
26-
Write documentation.
2726

28-
**Condensed definition of class** :class:`~pyEDAA.ProjectModel.Design`:
27+
Condensed definition of class :class:`~pyEDAA.ProjectModel.Design`
28+
==================================================================
2929

3030
.. code-block:: Python
3131

doc/ProjectModel/File.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ File
55

66
Generic description of a file in EDA design.
77

8-
.. rubric:: Table of Content
9-
10-
* :ref:`projectmodel-file2`
8+
.. todo::
119

10+
Write documentation.
1211

13-
.. rubric:: Class Hierarchy
1412

15-
.. inheritance-diagram:: pyEDAA.ProjectModel.File
16-
:parts: 1
13+
.. rubric:: Class Relationship
1714

15+
.. mermaid::
1816

19-
.. _projectmodel-file2:
17+
graph TD;
18+
Project --> Design;
19+
Design --> VHDLLibrary;
20+
Design --> FileSet;
21+
VHDLLibrary --> File;
22+
FileSet --> File
2023

21-
File
22-
====
24+
style File fill:#ee9b00
2325

24-
.. todo::
25-
26-
Write documentation.
2726

28-
**Condensed definition of class** :class:`~pyEDAA.ProjectModel.File`:
27+
Condensed definition of class :class:`~pyEDAA.ProjectModel.File`
28+
================================================================
2929

3030
.. code-block:: Python
3131

doc/ProjectModel/FileSet.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ FileSet
55

66
Generic description of an EDA file set (group of files).
77

8-
.. rubric:: Table of Content
9-
10-
* :ref:`projectmodel-fileset2`
8+
.. todo::
119

10+
Write documentation.
1211

13-
.. rubric:: Class Hierarchy
1412

15-
.. inheritance-diagram:: pyEDAA.ProjectModel.FileSet
16-
:parts: 1
13+
.. rubric:: Class Relationship
1714

15+
.. mermaid::
1816

19-
.. _projectmodel-fileset2:
17+
graph TD;
18+
Project --> Design;
19+
Design --> VHDLLibrary;
20+
Design --> FileSet;
21+
VHDLLibrary --> File;
22+
FileSet --> File
2023

21-
FileSet
22-
=======
24+
style FileSet fill:#ee9b00
2325

24-
.. todo::
25-
26-
Write documentation.
2726

28-
**Condensed definition of class** :class:`~pyEDAA.ProjectModel.FileSet`:
27+
Condensed definition of class :class:`~pyEDAA.ProjectModel.FileSet`
28+
===================================================================
2929

3030
.. code-block:: Python
3131

doc/ProjectModel/Project.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ Project
55

66
Generic description of an EDA project.
77

8-
.. rubric:: Table of Content
9-
10-
* :ref:`projectmodel-project2`
8+
.. todo::
119

10+
Write documentation.
1211

13-
.. rubric:: Class Hierarchy
1412

15-
.. inheritance-diagram:: pyEDAA.ProjectModel.Project
16-
:parts: 1
13+
.. rubric:: Class Relationship
1714

15+
.. mermaid::
1816

19-
.. _projectmodel-project2:
17+
graph TD;
18+
Project --> Design;
19+
Design --> VHDLLibrary;
20+
Design --> FileSet;
21+
VHDLLibrary --> File;
22+
FileSet --> File
2023

21-
Project
22-
=======
24+
style Project fill:#ee9b00
2325

24-
.. todo::
25-
26-
Write documentation.
2726

28-
**Condensed definition of class** :class:`~pyEDAA.ProjectModel.Project`:
27+
Condensed definition of class :class:`~pyEDAA.ProjectModel.Project`
28+
===================================================================
2929

3030
.. code-block:: Python
3131

doc/ProjectModel/VHDLLibrary.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ VHDL Library
55

66
Generic description of a VHDL library (group of VHDL files containing VHDL primary units).
77

8-
.. rubric:: Table of Content
9-
10-
* :ref:`projectmodel-vhdllib2`
11-
8+
.. todo::
129

13-
.. rubric:: Class Hierarchy
10+
Write documentation.
1411

15-
.. inheritance-diagram:: pyEDAA.ProjectModel.VHDLLibrary
16-
:parts: 1
1712

13+
.. rubric:: Class Relationship
1814

19-
.. _projectmodel-vhdllib2:
15+
.. mermaid::
2016

21-
VHDLLibrary
22-
===========
17+
graph TD;
18+
Project --> Design;
19+
Design --> VHDLLibrary;
20+
Design --> FileSet;
21+
VHDLLibrary --> File;
22+
FileSet --> File
2323

24-
.. todo::
24+
style VHDLLibrary fill:#ee9b00
2525

26-
Write documentation.
2726

28-
**Condensed definition of class** :class:`~pyEDAA.ProjectModel.VHDLLibrary`:
27+
Condensed definition of class :class:`~pyEDAA.ProjectModel.VHDLLibrary`
28+
=======================================================================
2929

3030
.. code-block:: Python
3131

0 commit comments

Comments
 (0)