Skip to content

Commit cb46f1e

Browse files
committed
More documentation.
1 parent cb6bb59 commit cb46f1e

File tree

6 files changed

+63
-1
lines changed

6 files changed

+63
-1
lines changed

doc/Analyze/index.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,45 @@ there is a double reference from graph's vertex via ``Value`` to the DOM object
5959
dependencyVertex["kind"] = DependencyGraphVertexKind.Context
6060
dependencyVertex["predefined"] = context._library._normalizedIdentifier in predefinedLibraries
6161
context._dependencyVertex = dependencyVertex
62+
63+
64+
2. Create Compile Order Graph
65+
=============================
66+
67+
3. Index Packages
68+
=================
69+
70+
4. Index Architectures
71+
======================
72+
73+
5. Link Contexts
74+
================
75+
76+
6. Link Architectures
77+
=====================
78+
79+
7. Link Package Bodies
80+
======================
81+
82+
8. Link Library References
83+
==========================
84+
85+
9. Link Package References
86+
==========================
87+
88+
10. Link Context References
89+
===========================
90+
91+
11. Link Components
92+
===================
93+
94+
12. Link Instantiations
95+
=======================
96+
97+
13. Create Hierarchy Graph
98+
==========================
99+
100+
14. Compute Compile Order
101+
=========================
102+
103+
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. _datastruct:compileorder:
2+
3+
Compile Order Graph
4+
###################

doc/DataStructure/DependencyGraph.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. _datastruct:dependgraph:
2+
3+
Dependency Graph
4+
################

doc/DataStructure/HierarchyGraph.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. _datastruct:dependgraph:
2+
3+
Hierarchy Graph
4+
###############

doc/DataStructure/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,11 @@ The compile order can be derived from dependency graph by:
6060
2. resolved further to the documents these design units are declared in
6161
3. resolve further which vertices correspond in the compile order graph
6262
4. if edges does not yet exist, add an edge between two documents in the compile order graph
63+
64+
65+
.. toctree::
66+
:hidden:
67+
68+
DependencyGraph
69+
HierarchyGraph
70+
CompileOrderGraph

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@
213213
# "inherited-members": True,
214214
# "exclude-members": "__weakref__"
215215
#}
216-
#autodoc_class_signature = "separated"
216+
autodoc_class_signature = "separated"
217217
autodoc_member_order = "bysource" # alphabetical, groupwise, bysource
218218
autodoc_typehints = "both"
219219
#autoclass_content = "both"

0 commit comments

Comments
 (0)