Skip to content

Commit 74b2e8e

Browse files
chudur-budurDiptorup Deb
authored andcommitted
Fix jumbled code renderings
1 parent 203e21d commit 74b2e8e

File tree

11 files changed

+55
-51
lines changed

11 files changed

+55
-51
lines changed

docs/source/user_guide/debugging/altering.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _altering:
2+
13
Altering Execution
24
==================
35

@@ -22,7 +24,7 @@ Example
2224

2325
Source code :file:`numba_dpex/examples/debug/side-by-side-2.py`:
2426

25-
.. literalinclude:: ../../../numba_dpex/examples/debug/side-by-side-2.py
27+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/side-by-side-2.py
2628
:pyobject: common_loop_body
2729
:linenos:
2830
:lineno-match:

docs/source/user_guide/debugging/backtrace.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1+
.. _backtrace:
2+
13
Backtrace
24
==========
35

46
The ``backtrace`` command displays a summary of how your program got where it
57
is. Consider the following example
68
``numba_dpex/examples/debug/simple_dpex_func.py``:
79

8-
.. literalinclude:: ../../../numba_dpex/examples/debug/simple_dpex_func.py
9-
:lines: 15-
10+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/simple_dpex_func.py
11+
:lines: 5-
1012
:linenos:
1113
:lineno-match:
1214

@@ -19,13 +21,13 @@ numba_dpex.func.
1921

2022
Example 1:
2123

22-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/backtrace_kernel
24+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/backtrace_kernel
2325
:language: shell-session
2426
:emphasize-lines: 8,9
2527

2628
Example 2:
2729

28-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/backtrace
30+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/backtrace
2931
:language: shell-session
3032
:emphasize-lines: 8-10
3133

docs/source/user_guide/debugging/breakpoints.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ See also:
2222
Consider the following numba-dpex kernel code (refer
2323
``numba_dpex/examples/debug/simple_sum.py`` for full example):
2424

25-
.. literalinclude:: ../../../numba_dpex/examples/debug/simple_sum.py
26-
:lines: 15-
25+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/simple_sum.py
26+
:lines: 5-
2727
:linenos:
2828
:lineno-match:
2929

@@ -32,7 +32,7 @@ Consider the following numba-dpex kernel code (refer
3232

3333
The debugger output:
3434

35-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/break_func
35+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/break_func
3636
:language: shell-session
3737
:emphasize-lines: 3
3838

@@ -41,7 +41,7 @@ The debugger output:
4141

4242
The debugger output:
4343

44-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/break_line_number
44+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/break_line_number
4545
:language: shell-session
4646
:emphasize-lines: 3
4747

@@ -50,7 +50,7 @@ The debugger output:
5050

5151
The debugger output:
5252

53-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/break_file_func
53+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/break_file_func
5454
:language: shell-session
5555
:emphasize-lines: 3
5656

@@ -59,7 +59,7 @@ The debugger output:
5959

6060
The debugger output:
6161

62-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/break_conditional
62+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/break_conditional
6363
:language: shell-session
6464
:emphasize-lines: 3
6565

@@ -69,13 +69,13 @@ Breakpoints with nested functions
6969
Consider numba-dpex kernel code. See the source file
7070
``numba_dpex/examples/debug/simple_dpex_func.py``:
7171

72-
.. literalinclude:: ../../../numba_dpex/examples/debug/simple_dpex_func.py
73-
:lines: 15-
72+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/simple_dpex_func.py
73+
:lines: 5-
7474
:linenos:
7575
:lineno-match:
7676

7777
The debugger output:
7878

79-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/break_nested_func
79+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/break_nested_func
8080
:language: shell-session
8181
:emphasize-lines: 3

docs/source/user_guide/debugging/data.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ See `GDB* documentation <https://www.sourceware.org/gdb/onlinedocs/gdb/Data.html
1010

1111
To print the value of a variable, run the ``print <variable>`` command.
1212

13-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/local_variables_0
13+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/local_variables_0
1414
:language: shell-session
1515
:lines: 67-72
1616
:emphasize-lines: 1-6
@@ -24,7 +24,7 @@ Example - Complex Data Types
2424

2525
Source code :file:`numba_dpex/examples/debug/side-by-side-2.py`:
2626

27-
.. literalinclude:: ../../../numba_dpex/examples/debug/side-by-side-2.py
27+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/side-by-side-2.py
2828
:pyobject: common_loop_body
2929
:linenos:
3030
:lineno-match:

docs/source/user_guide/debugging/debugging_environment.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Configure debugging environment
2727

2828
You can check the correctness of the work with the following example:
2929

30-
.. literalinclude:: ../../../numba_dpex/examples/debug/simple_sum.py
31-
:lines: 15-
30+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/simple_sum.py
31+
:lines: 5-
3232
:linenos:
3333
:lineno-match:
3434

docs/source/user_guide/debugging/frame_info.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Example
2020

2121
Source code :file:`numba_dpex/examples/debug/side-by-side.py`:
2222

23-
.. literalinclude:: ../../../numba_dpex/examples/debug/side-by-side.py
23+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/side-by-side.py
2424
:pyobject: common_loop_body
2525
:linenos:
2626
:lineno-match:
@@ -59,21 +59,21 @@ Example
5959

6060
Source code :file:`sum_local_vars.py`:
6161

62-
.. literalinclude:: ../../../numba_dpex/examples/debug/sum_local_vars.py
63-
:lines: 15-
62+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/sum_local_vars.py
63+
:lines: 5-
6464
:linenos:
6565
:lineno-match:
6666

6767
Run the debugger with ``NUMBA_OPT=0``:
6868

69-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/local_variables_0
69+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/local_variables_0
7070
:language: shell-session
7171
:lines: 1-6
7272

7373
Use ``info locals``.
7474
Note that uninitialized variables are zeros:
7575

76-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/local_variables_0
76+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/local_variables_0
7777
:language: shell-session
7878
:lines: 8-48
7979
:emphasize-lines: 1-16, 24-39

docs/source/user_guide/debugging/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ Example of Intel® Distribution for GDB* usage
4242

4343
You can use a sample kernel code, :file:`simple_sum.py`, for basic debugging:
4444

45-
.. literalinclude:: ../../../numba_dpex/examples/debug/simple_sum.py
46-
:lines: 15-
45+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/simple_sum.py
46+
:lines: 5-
4747
:linenos:
4848
:lineno-match:
4949

5050
Use the following commands to create a breakpoint inside the kernel and run the
5151
debugger:
5252

53-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/simple_sum
53+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/simple_sum
5454
:language: shell-session
5555

5656
.. _debugging-features-and-limitations:

docs/source/user_guide/debugging/local_variables.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Example
2525

2626
Source code :file:`numba_dpex/examples/debug/sum_local_vars.py`:
2727

28-
.. literalinclude:: ../../../numba_dpex/examples/debug/sum_local_vars.py
28+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/sum_local_vars.py
2929
:pyobject: data_parallel_sum
3030
:linenos:
3131
:lineno-match:
@@ -97,7 +97,7 @@ Example 1 - Using ``NUMBA_EXTEND_VARIABLE_LIFETIMES``
9797

9898
Source code :file:`numba_dpex/tests/debugging/test_info.py`:
9999

100-
.. literalinclude:: ../../../numba_dpex/examples/debug/side-by-side.py
100+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/side-by-side.py
101101
:pyobject: common_loop_body
102102
:linenos:
103103
:lineno-match:
@@ -150,7 +150,7 @@ Example 2 - Using ``NUMBA_DUMP_ANNOTATION``
150150

151151
Source code :file:`numba_dpex/examples/debug/sum_local_vars.py`:
152152

153-
.. literalinclude:: ../../../numba_dpex/examples/debug/sum_local_vars.py
153+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/sum_local_vars.py
154154
:pyobject: data_parallel_sum
155155
:linenos:
156156
:lineno-match:
@@ -230,8 +230,8 @@ As a workaround you can expand lifetime of the variable by using it (i.e.
230230
passing to dummy function `revive()`) at the end of the function. So numba will
231231
not insert `del a` until the end of the function.
232232

233-
.. literalinclude:: ../../../numba_dpex/examples/debug/sum_local_vars_revive.py
234-
:lines: 20-31
233+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/sum_local_vars_revive.py
234+
:lines: 5-
235235
:linenos:
236236
:lineno-match:
237237

@@ -350,27 +350,27 @@ Example 3 - Using ``info locals``
350350

351351
Source code :file:`sum_local_vars.py`:
352352

353-
.. literalinclude:: ../../../numba_dpex/examples/debug/sum_local_vars.py
354-
:lines: 15-
353+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/sum_local_vars.py
354+
:lines: 5-
355355
:linenos:
356356
:lineno-match:
357357

358358
Run the debugger with ``NUMBA_OPT=0``:
359359

360-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/local_variables_0
360+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/local_variables_0
361361
:language: shell-session
362362
:lines: 1-6
363363

364364
Run the ``info locals`` command. The sample output on "no optimization" level ``NUMBA_OPT=0`` is as follows:
365365

366-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/local_variables_0
366+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/local_variables_0
367367
:language: shell-session
368368
:lines: 8-48
369369
:emphasize-lines: 1-16, 24-39
370370

371371
Since the debugger does not hit a line with the target variable ``l1``, the value equals 0. The true value of the variable ``l1`` is shown after stepping to line 22.
372372

373-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/local_variables_0
373+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/local_variables_0
374374
:language: shell-session
375375
:lines: 49-66
376376
:emphasize-lines: 1-16

docs/source/user_guide/debugging/numba-0.55.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Example
2828

2929
Source code :file:`numba_dpex/examples/debug/side-by-side.py`:
3030

31-
.. literalinclude:: ../../../numba_dpex/examples/debug/side-by-side.py
31+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/side-by-side.py
3232
:pyobject: common_loop_body
3333
:linenos:
3434
:lineno-match:

docs/source/user_guide/debugging/stepping.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ Consider the following examples.
88

99
``numba_dpex/examples/debug/simple_sum.py``:
1010

11-
.. literalinclude:: ../../../numba_dpex/examples/debug/simple_sum.py
12-
:lines: 15-
11+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/simple_sum.py
12+
:lines: 5-
1313
:linenos:
1414
:lineno-match:
1515

1616
Example with a nested function ``numba_dpex/examples/debug/simple_dpex_func.py``:
1717

18-
.. literalinclude:: ../../../numba_dpex/examples/debug/simple_dpex_func.py
19-
:lines: 15-
18+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/simple_dpex_func.py
19+
:lines: 5-
2020
:linenos:
2121
:lineno-match:
2222

@@ -26,13 +26,13 @@ Example with a nested function ``numba_dpex/examples/debug/simple_dpex_func.py``
2626

2727
Run the debugger and use the following commands:
2828

29-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/step_sum
29+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/step_sum
3030
:language: shell-session
3131
:emphasize-lines: 8-13
3232

3333
You can use stepping to switch to a nested function. See the example below:
3434

35-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/step_dpex_func
35+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/step_dpex_func
3636
:language: shell-session
3737
:emphasize-lines: 8-14
3838

@@ -41,7 +41,7 @@ You can use stepping to switch to a nested function. See the example below:
4141

4242
The command allows you to move forward by machine instructions. The example uses an additional command ``x/i $pc``, which prints the instruction to be executed.
4343

44-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/stepi
44+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/stepi
4545
:language: shell-session
4646
:emphasize-lines: 8-13
4747

@@ -50,7 +50,7 @@ The command allows you to move forward by machine instructions. The example uses
5050

5151
The command has stepping-like behavior, but it skips nested functions.
5252

53-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/next
53+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/next
5454
:language: shell-session
5555
:emphasize-lines: 8-14
5656

@@ -66,7 +66,7 @@ configure it for more efficient debugging. To ensure the current thread executes
6666
a single line without interference, set the scheduler-locking setting to `on` or
6767
`step`:
6868

69-
.. literalinclude:: ../../../numba_dpex/examples/debug/commands/docs/sheduler_locking
69+
.. literalinclude:: ./../../../../numba_dpex/examples/debug/commands/docs/sheduler_locking
7070
:language: shell-session
7171
:emphasize-lines: 8-13
7272

0 commit comments

Comments
 (0)