Skip to content

Commit 288a0e0

Browse files
committed
doc: Update VTR task directory structure figure
Removes dependency on graphviz to generate figures in documentation which was failing on readthedocs. We now generate the figure with latex/tikz and check-in the figure.
1 parent 15ff7a0 commit 288a0e0

File tree

5 files changed

+2630
-57
lines changed

5 files changed

+2630
-57
lines changed

doc/src/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@
5555
extensions = [
5656
'sphinx.ext.todo',
5757
'sphinx.ext.mathjax',
58-
'sphinx.ext.graphviz',
5958
'sphinx_markdown_tables',
6059
'sdcdomain',
6160
'archdomain',

doc/src/vtr/tasks.rst

Lines changed: 3 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -43,63 +43,10 @@ The symbolic link ``latest`` will point to the most recent ``run<#>`` directory.
4343

4444
.. _fig_vtr_tasks_file_layout:
4545

46-
.. graphviz::
47-
:caption: Task directory layout.
46+
.. figure:: vtr_task_fig.*
47+
:width: 75%
4848

49-
digraph {
50-
#Default style
51-
node[shape=Mrecord, style=filled, fillcolor="/blues4/2:/blues4/3", gradientangle=270, fontname="arial"]
52-
53-
#Nodes
54-
node_task[label="\<task_name\>", fillcolor="/reds4/2:/reds4/3"];
55-
node_config[label="config", fillcolor="/reds4/2:/reds4/3"];
56-
node_config_txt[label="config.txt", fillcolor="/reds4/2:/reds4/3"];
57-
58-
node_run1[label="run001"];
59-
node_run2[label="run002"];
60-
node_run3[label="run003"];
61-
node_runlatest[label="latest", fillcolor="/blues4/1:/blues4/2"];
62-
63-
node_arch1[label="\<arch1\>"];
64-
node_arch2[label="\<arch2\>"];
65-
node_arch_cont[label="..."];
66-
67-
node_circuit1[label="\<circuit1\>"];
68-
node_circuit2[label="\<circuit2\>"];
69-
node_circuit_cont[label="..."];
70-
71-
node_params1a[label="\<params1\>"]
72-
node_params1b[label="\<params2\>"]
73-
node_params1_cont[label="..."]
74-
75-
node_results1[label="odin.out\nabc.out\nvpr.out", style="", color="/blues4/4"]
76-
node_results2[label="odin.out\nabc.out\nvpr.out", style="", color="/blues4/4"]
77-
78-
#Edges
79-
node_task -> node_config -> node_config_txt;
80-
node_task -> node_run1;
81-
node_task -> node_run2;
82-
node_task -> node_run3;
83-
84-
node_runlatest -> node_run3 [constraint=false, color=grey];
85-
86-
node_run1 -> node_arch1;
87-
node_run1 -> node_arch2;
88-
node_run1 -> node_arch_cont;
89-
90-
node_arch1 -> node_circuit1;
91-
node_arch1 -> node_circuit2;
92-
node_arch1 -> node_circuit_cont;
93-
94-
node_circuit1 -> node_params1a;
95-
node_circuit1 -> node_params1b;
96-
node_circuit1 -> node_params1_cont;
97-
98-
node_params1a -> node_results1;
99-
node_params1b -> node_results2;
100-
101-
{rank = same; node_run1; node_run2; node_run3; node_runlatest; rankdir=LR; }
102-
}
49+
Task directory layout.
10350

10451
Creating a New Task
10552
~~~~~~~~~~~~~~~~~~~

doc/src/vtr/vtr_task_fig.pdf

29 KB
Binary file not shown.

0 commit comments

Comments
 (0)