Skip to content

Commit 20b97ec

Browse files
oddballoddball
authored
Merge pull request #68 from vermaete/master
Sphinx/reStructuredText fixes
2 parents 167c0f0 + dc6c9a8 commit 20b97ec

23 files changed

Lines changed: 916 additions & 267 deletions

‎Makefile‎

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
ifneq ($(wildcard vmakefile),)
32
include vmakefile
43
endif
@@ -9,7 +8,7 @@ XSD_DIR = schema1.5
98
all: gen
109

1110
gen:
12-
# no config
11+
# no config
1312
ipxact2systemverilog --srcFile example/input/test.xml --destDir example/output
1413
ipxact2rst --srcFile example/input/test.xml --destDir example/output
1514
ipxact2md --srcFile example/input/test.xml --destDir example/output
@@ -18,43 +17,45 @@ gen:
1817
ipxact2c --srcFile example/input/test.xml --destDir example/output
1918
pandoc -s example/output/example.rst -o example/output/example.html
2019
pandoc -s example/output/example.rst -o example/output/example.rtf
21-
22-
# default config
23-
ipxact2systemverilog --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
24-
ipxact2rst --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
25-
ipxact2md --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
26-
ipxact2vhdl --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
27-
ipxact2c --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
28-
29-
# no default config
30-
ipxact2systemverilog --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
31-
ipxact2rst --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
32-
ipxact2md --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
33-
ipxact2vhdl --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
34-
ipxact2c --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
35-
36-
# RestructuredText and Sphinx with Wavedrom
37-
ipxact2rst --srcFile example/input/test.xml --destDir example/output_sphinx --config example/input/sphinx.ini
20+
pandoc -s example/output/example.rst -o example/output/example.pdf
21+
22+
# default config
23+
ipxact2systemverilog --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
24+
ipxact2rst --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
25+
ipxact2md --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
26+
ipxact2vhdl --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
27+
ipxact2c --srcFile example/input/test.xml --destDir example/output_default --config example/input/default.ini
28+
29+
# no default config
30+
ipxact2systemverilog --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
31+
ipxact2rst --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
32+
ipxact2md --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
33+
ipxact2vhdl --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
34+
ipxact2c --srcFile example/input/test.xml --destDir example/output_no_default --config example/input/no_default.ini
35+
36+
# RestructuredText and Sphinx with Wavedrom
37+
ipxact2rst --srcFile example/input/test.xml --destDir example/output_sphinx --config example/input/sphinx.ini
3838
sphinx-build example/output_sphinx example/output_sphinx/build -q -b latex
3939
make -C example/output_sphinx/build
4040
cp example/output_sphinx/build/example.pdf example/output_sphinx
4141

42-
# test
42+
# test2
4343
ipxact2systemverilog --srcFile example/input/test2.xml --destDir example/output
4444
ipxact2rst --srcFile example/input/test2.xml --destDir example/output
4545
ipxact2md --srcFile example/input/test2.xml --destDir example/output
4646
ipxact2vhdl --srcFile example/input/test2.xml --destDir example/output
4747
ipxact2md --srcFile example/input/test2.xml --destDir example/output
4848
ipxact2c --srcFile example/input/test2.xml --destDir example/output
49+
pandoc -s example/output/example2.rst -o example/output/example2.pdf
4950

5051
cp example/output/example2.rst example/output_sphinx2
51-
ipxact2rst --srcFile example/input/test2.xml --destDir example/output_sphinx2 --config example/input/sphinx.ini
52+
ipxact2rst --srcFile example/input/test2.xml --destDir example/output_sphinx2 --config example/input/sphinx.ini
5253
sphinx-build example/output_sphinx2 example/output_sphinx2/build -q -b latex
5354
make -C example/output_sphinx2/build
5455
cp example/output_sphinx2/build/example2.pdf example/output_sphinx2/example2.pdf
5556

5657

57-
compile:
58+
compile:
5859
test -d work || vlib work
5960
vlog +incdir+example/output example/output/example_sv_pkg.sv example/tb/sv_dut.sv example/tb/tb.sv
6061
vcom -93 example/output/*.vhd example/tb/vhd_dut.vhd
@@ -100,10 +101,12 @@ validate:
100101
xmllint --noout --schema ipxact2systemverilog/xml/ipxact-1.5/component.xsd example/input/test2.xml
101102

102103
test_rst:
103-
rst-lint example/output/*.rst
104+
rst-lint example/output/example.rst # example2.rst does have an error when not usign Sphinx
105+
rst-lint example/output_default/*.rst
106+
rst-lint example/output_no_default/*.rst
104107

105108
venv: requirements.txt
106109
python3 -m venv ./venv
107110
pip install wheel
108-
python3 setup.py bdist_wheel
111+
python3 setup.py bdist_wheel
109112
pip install --upgrade -r requirements.txt

‎example/input/sphinx.ini‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ PublicConvFunct = yes
77
std = resolved
88

99
[rst]
10+
sphinx = yes
1011
wavedrom = yes

‎example/input/test2.xml‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,46 @@
4949
</spirit:writeValueConstraint>
5050
</spirit:field>
5151
</spirit:register>
52-
</spirit:addressBlock>
52+
53+
<spirit:register>
54+
<spirit:name>samename</spirit:name>
55+
<spirit:description>samename register</spirit:description>
56+
<spirit:addressOffset>0x1d</spirit:addressOffset>
57+
<spirit:size>8</spirit:size>
58+
<spirit:access>read-only</spirit:access>
59+
<spirit:reset>
60+
<spirit:value>0x00</spirit:value>
61+
</spirit:reset>
62+
<spirit:field>
63+
<spirit:name>samename</spirit:name>
64+
<spirit:bitOffset>0</spirit:bitOffset>
65+
<spirit:bitWidth>2</spirit:bitWidth>
66+
<spirit:enumeratedValues>
67+
<spirit:enumeratedValue>
68+
<spirit:name>a</spirit:name>
69+
<spirit:description>a</spirit:description>
70+
<spirit:value>0</spirit:value>
71+
</spirit:enumeratedValue>
72+
<spirit:enumeratedValue>
73+
<spirit:name>b</spirit:name>
74+
<spirit:description>b</spirit:description>
75+
<spirit:value>1</spirit:value>
76+
</spirit:enumeratedValue>
77+
<spirit:enumeratedValue>
78+
<spirit:name>c</spirit:name>
79+
<spirit:description>c</spirit:description>
80+
<spirit:value>2</spirit:value>
81+
</spirit:enumeratedValue>
82+
<spirit:enumeratedValue>
83+
<spirit:name>d</spirit:name>
84+
<spirit:description>d</spirit:description>
85+
<spirit:value>3</spirit:value>
86+
</spirit:enumeratedValue>
87+
</spirit:enumeratedValues>
88+
</spirit:field>
89+
</spirit:register>
90+
91+
</spirit:addressBlock>
5392
</spirit:memoryMap>
5493
</spirit:memoryMaps>
5594
</spirit:component>

0 commit comments

Comments
 (0)