Skip to content

Commit 5373101

Browse files
committed
Fix inline code blocks formatting
All this while it was using `code` which italicizes the code instead of ``code``. Signed-off-by: Daniel Lim Wee Soong <weesoong.lim@gmail.com>
1 parent b989576 commit 5373101

11 files changed

Lines changed: 26 additions & 26 deletions

File tree

tests/clocks/dff_comb_one_clock/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
D-Flipflop with combinational logic
22
+++++++++++++++++++++++++++++++++++
33

4-
The following shows a combinational logic design driven by a clock. `input wire a` should be detected as a clock because it drives the flip flop.
4+
The following shows a combinational logic design driven by a clock. ``input wire a`` should be detected as a clock because it drives the flip flop.
55

66
.. symbolator:: ../../../tests/clocks/dff_comb_one_clock/dff_comb_one_clock.sim.v
77

@@ -16,7 +16,7 @@ The following shows a combinational logic design driven by a clock. `input wire
1616
:start-after: */
1717
:caption: tests/clocks/dff_comb_one_clock/dff_comb_one_clock.sim.v
1818
19-
The `is_clock` attribute of the `a` port is set to 1, and the ports `b`, `c` and `d` have their `clock` attribute set to `a`.
19+
The ``is_clock`` attribute of the ``a`` port is set to 1, and the ports ``b``, ``c`` and ``d`` have their ``clock`` attribute set to ``a``.
2020

2121
.. literalinclude:: ../../../tests/clocks/dff_comb_one_clock/golden.model.xml
2222
:language: xml
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
D-Flipflop with one clock
22
+++++++++++++++++++++++++++++++++++
33

4-
The following shows a simple D-flip flop driven by one clock. `input wire a` should be detected as a clock because it drives the flip flop.
4+
The following shows a simple D-flip flop driven by one clock. ``input wire a`` should be detected as a clock because it drives the flip flop.
55

6-
.. symbolator:: ../../../tests/clocks/dff_one_clock/dff_one_clock.sim.v
6+
.. symbolator:: ./dff_one_clock.sim.v
77

8-
.. verilog-diagram:: ../../../tests/clocks/dff_one_clock/dff_one_clock.sim.v
8+
.. verilog-diagram:: ./dff_one_clock.sim.v
99
:type: netlistsvg
1010
:module: BLOCK
1111

1212
|
1313
14-
.. literalinclude:: ../../../tests/clocks/dff_one_clock/dff_one_clock.sim.v
14+
.. literalinclude:: ./dff_one_clock.sim.v
1515
:language: verilog
1616
:start-after: */
1717
:caption: tests/clocks/dff_one_clock/dff_one_clock.sim.v
1818
19-
As you can see in the generated model, the `is_clock` attribute of the `a` port is set to 1, while the `b` and `c` ports have their `clock` attribute set to `a`.
19+
As you can see in the generated model, the ``is_clock`` attribute of the ``a`` port is set to 1, while the ``b`` and ``c`` ports have their ``clock`` attribute set to ``a``.
2020

21-
.. literalinclude:: ../../../tests/clocks/dff_one_clock/golden.model.xml
21+
.. literalinclude:: ./golden.model.xml
2222
:language: xml
2323
:caption: tests/clocks/dff_one_clock/golden.model.xml

tests/clocks/dff_two_clocks/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
D-Flipflop with two clocks
22
+++++++++++++++++++++++++++++++++++
33

4-
`input wire c1` and `input wire c2` should be detected as clocks because they drive the flip flop.
4+
``input wire c1`` and ``input wire c2`` should be detected as clocks because they drive the flip flop.
55

66
.. symbolator:: ../../../tests/clocks/dff_two_clocks/dff_two_clocks.sim.v
77

@@ -16,7 +16,7 @@ D-Flipflop with two clocks
1616
:start-after: */
1717
:caption: tests/clocks/dff_two_clocks/dff_two_clocks.sim.v
1818
19-
The `is_clock` attribute of the `c1` and `c2` ports are set to 1, and the ports `a`, `b`, `c`, `o1` and `o2` have their `clock` attribute set to the respective clocks they are driven by.
19+
The ``is_clock`` attribute of the ``c1`` and ``c2`` ports are set to 1, and the ports ``a``, ``b``, ``c``, ``o1`` and ``o2`` have their ``clock`` attribute set to the respective clocks they are driven by.
2020

2121
.. literalinclude:: ../../../tests/clocks/dff_two_clocks/golden.model.xml
2222
:language: xml

tests/clocks/input_attr_clock/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Manually set input as clock by setting the CLOCK attribute
22
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
33

4-
The following shows that `input wire a` is given the `(* CLOCK *)` attribute.
4+
The following shows that ``input wire a`` is given the ``(* CLOCK *)`` attribute.
55

66
.. symbolator:: ../../../tests/clocks/input_attr_clock/input_attr_clock.sim.v
77

@@ -12,7 +12,7 @@ The following shows that `input wire a` is given the `(* CLOCK *)` attribute.
1212
:start-after: */
1313
:caption: tests/clocks/input_attr_clock/input_attr_clock.sim.v
1414
15-
As such, the `is_clock` attribute of the `a` port is set to 1.
15+
As such, the ``is_clock`` attribute of the ``a`` port is set to 1.
1616

1717
.. literalinclude:: ../../../tests/clocks/input_attr_clock/golden.model.xml
1818
:language: xml

tests/clocks/input_attr_not_clock/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Force input as regular input by setting the CLOCK attribute
22
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
33

4-
`input wire a` should be detected as a clock because it drives the flip flop. However, it has the attribute CLOCK set to 0 which should force it to be a regular input.
4+
``input wire a`` should be detected as a clock because it drives the flip flop. However, it has the attribute CLOCK set to 0 which should force it to be a regular input.
55

66
.. symbolator:: ../../../tests/clocks/input_attr_not_clock/block.sim.v
77

@@ -16,7 +16,7 @@ Force input as regular input by setting the CLOCK attribute
1616
:start-after: */
1717
:caption: tests/clocks/input_attr_not_clock/block.sim.v
1818
19-
As such, the `is_clock` attribute of the `a` port is not set.
19+
As such, the ``is_clock`` attribute of the ``a`` port is not set.
2020

2121
.. literalinclude:: ../../../tests/clocks/input_attr_not_clock/golden.model.xml
2222
:language: xml

tests/clocks/input_named_clk/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Set input as clock by name (clk)
22
+++++++++++++++++++++++++++++++++++
33

4-
An input wire can be set as a clock by assigning `clk` as its name.
4+
An input wire can be set as a clock by assigning ``clk`` as its name.
55

66
.. symbolator:: ../../../tests/clocks/input_named_clk/input_named_clk.sim.v
77

@@ -12,7 +12,7 @@ An input wire can be set as a clock by assigning `clk` as its name.
1212
:start-after: */
1313
:caption: tests/clocks/input_named_clk/input_named_clk.sim.v
1414
15-
As such, the `is_clock` attribute of the `clk` port is set to 1, without needing to set anything else in the verilog code.
15+
As such, the ``is_clock`` attribute of the ``clk`` port is set to 1, without needing to set anything else in the verilog code.
1616

1717
.. literalinclude:: ../../../tests/clocks/input_named_clk/golden.model.xml
1818
:language: xml

tests/clocks/input_named_regex/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Set input as clock by name (regex)
22
+++++++++++++++++++++++++++++++++++
33

4-
An input wire can be set as a clock by having `clk` in its name (case insensitive).
4+
An input wire can be set as a clock by having ``clk`` in its name (case insensitive).
55

66
.. symbolator:: ../../../tests/clocks/input_named_regex/block.sim.v
77

@@ -12,7 +12,7 @@ An input wire can be set as a clock by having `clk` in its name (case insensitiv
1212
:start-after: */
1313
:caption: tests/clocks/input_named_regex/block.sim.v
1414
15-
As such, the `is_clock` attribute of wires with a variation of `clk` in their name is set to 1.
15+
As such, the ``is_clock`` attribute of wires with a variation of ``clk`` in their name is set to 1.
1616

1717
.. literalinclude:: ../../../tests/clocks/input_named_regex/golden.model.xml
1818
:language: xml

tests/clocks/multiple_inputs_named_clk/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Set inputs as clock by name (multiple clock inputs)
22
+++++++++++++++++++++++++++++++++++++++++++++++++++
33

4-
`input wire rdclk` and `input wire wrclk` have `clk` in their names, hence are recognized as clock inputs by v2x.
4+
``input wire rdclk`` and ``input wire wrclk`` have ``clk`` in their names, hence are recognized as clock inputs by v2x.
55

66
.. symbolator:: ../../../tests/clocks/multiple_inputs_named_clk/multiple_inputs_named_clk.sim.v
77

@@ -12,7 +12,7 @@ Set inputs as clock by name (multiple clock inputs)
1212
:start-after: */
1313
:caption: tests/clocks/multiple_inputs_named_clk/multiple_inputs_named_clk.sim.v
1414
15-
As such, the `is_clock` attribute of the `rdclk` and `wrclk` ports are set to 1.
15+
As such, the ``is_clock`` attribute of the ``rdclk`` and ``wrclk`` ports are set to 1.
1616

1717
.. literalinclude:: ../../../tests/clocks/multiple_inputs_named_clk/golden.model.xml
1818
:language: xml

tests/clocks/multiple_outputs_named_clk/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Set outputs as clock by name (multiple clock outputs)
22
++++++++++++++++++++++++++++++++++++++++++++++++++++++
33

4-
`output wire rdclk` and `output wire wrclk` have `clk` in their names, hence are recognized as clock inputs by v2x.
4+
``output wire rdclk`` and ``output wire wrclk`` have ``clk`` in their names, hence are recognized as clock inputs by v2x.
55

66
.. symbolator:: ../../../tests/clocks/multiple_outputs_named_clk/multiple_outputs_named_clk.sim.v
77

@@ -12,7 +12,7 @@ Set outputs as clock by name (multiple clock outputs)
1212
:start-after: */
1313
:caption: tests/clocks/multiple_outputs_named_clk/multiple_outputs_named_clk.sim.v
1414
15-
As such, the `is_clock` attribute of the `rdclk` and `wrclk` ports are set to 1.
15+
As such, the ``is_clock`` attribute of the ``rdclk`` and ``wrclk`` ports are set to 1.
1616

1717
.. literalinclude:: ../../../tests/clocks/multiple_outputs_named_clk/golden.model.xml
1818
:language: xml

tests/clocks/output_attr_clock/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Manually set output as clock by setting the CLOCK attribute
22
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
33

4-
The following shows that `output wire o` is given the `(* CLOCK *)` attribute.
4+
The following shows that ``output wire o`` is given the ``(* CLOCK *)`` attribute.
55

66
.. symbolator:: ../../../tests/clocks/output_attr_clock/output_attr_clock.sim.v
77

@@ -12,7 +12,7 @@ The following shows that `output wire o` is given the `(* CLOCK *)` attribute.
1212
:start-after: */
1313
:caption: tests/clocks/output_attr_clock/output_attr_clock.sim.v
1414
15-
As such, the `is_clock` attribute of the `o` port is set to 1.
15+
As such, the ``is_clock`` attribute of the ``o`` port is set to 1.
1616

1717
.. literalinclude:: ../../../tests/clocks/output_attr_clock/golden.model.xml
1818
:language: xml

0 commit comments

Comments
 (0)