Skip to content

Commit b46a35c

Browse files
RemiLehedpgrote
authored andcommitted
Consistently use language:none for literal include in the documentation (BLAST-WarpX#6336)
This is a follow-up of BLAST-WarpX#6333 and makes these changes consistent across the documentation.
1 parent 6aa5c32 commit b46a35c

File tree

10 files changed

+16
-16
lines changed

10 files changed

+16
-16
lines changed

Examples/Physics_applications/beam_beam_collision/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The PICMI input file is not available for this example yet.
2626
For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.
2727

2828
.. literalinclude:: inputs_test_3d_beam_beam_collision
29-
:language: ini
29+
:language: none
3030
:caption: You can copy this file from ``Examples/Physics_applications/beam_beam_collision/inputs_test_3d_beam_beam_collision``.
3131

3232

Examples/Physics_applications/free_electron_laser/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Run
2525
This example can be run with the WarpX executable using an input file: ``warpx.1d inputs_test_1d_fel``. For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.
2626

2727
.. literalinclude:: inputs_test_1d_fel
28-
:language: ini
28+
:language: none
2929
:caption: You can copy this file from ``Examples/Physics_applications/free_electron_laser/inputs_test_1d_fel``.
3030

3131
Visualize
@@ -42,5 +42,5 @@ emitted FEL radiation (red) slipping ahead of the beam.
4242
This figure was obtained with the script below, which can be run with ``python3 plot_sim.py``.
4343

4444
.. literalinclude:: plot_sim.py
45-
:language: ini
45+
:language: none
4646
:caption: You can copy this file from ``Examples/Physics_applications/free_electron_laser/plot_sim.py``.

Examples/Physics_applications/laser_acceleration/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with `
3838
.. tab-item:: Executable: Input File
3939

4040
.. literalinclude:: inputs_base_3d
41-
:language: ini
41+
:language: none
4242
:caption: You can copy this file from ``Examples/Physics_applications/laser_acceleration/inputs_base_3d``.
4343

4444
.. tab-item:: RZ
@@ -59,7 +59,7 @@ For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with `
5959
.. tab-item:: Executable: Input File
6060

6161
.. literalinclude:: inputs_base_rz
62-
:language: ini
62+
:language: none
6363
:caption: You can copy this file from ``Examples/Physics_applications/laser_acceleration/inputs_base_rz``.
6464

6565
Analyze

Examples/Physics_applications/laser_ion/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This example can be run **either** as:
4343
.. tab-item:: Executable: Input File
4444

4545
.. literalinclude:: inputs_test_2d_laser_ion_acc
46-
:language: ini
46+
:language: none
4747
:caption: You can copy this file from ``Examples/Physics_applications/laser_ion/inputs_test_2d_laser_ion_acc``.
4848

4949
Analyze

Examples/Physics_applications/pierce_diode/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ This example can be run with the WarpX executable using an input file: ``warpx.1
4747
For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.
4848

4949
.. literalinclude:: inputs_test_1d_pierce_diode
50-
:language: ini
50+
:language: none
5151
:caption: You can copy this file from ``Examples/Physics_applications/pierce_diode/inputs_test_1d_pierce_diode``.
5252

5353
Visualize
@@ -62,5 +62,5 @@ The figure below shows the results of the simulation (orange curves), which agre
6262
This figure was obtained with the script below, which can be run with ``python3 plot_sim.py``.
6363

6464
.. literalinclude:: plot_sim.py
65-
:language: ini
65+
:language: none
6666
:caption: You can copy this file from ``Examples/Physics_applications/pierce_diode/plot_sim.py``.

Examples/Physics_applications/plasma_acceleration/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with `
4444
.. tab-item:: Executable: Input File
4545

4646
.. literalinclude:: inputs_base_3d
47-
:language: ini
47+
:language: none
4848
:caption: You can copy this file from ``Examples/Physics_applications/plasma_acceleration/inputs_base_3d``.
4949

5050
Analyze

Examples/Physics_applications/plasma_mirror/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with `
3434
.. tab-item:: Executable: Input File
3535

3636
.. literalinclude:: inputs_test_2d_plasma_mirror
37-
:language: ini
37+
:language: none
3838
:caption: You can copy this file from ``Examples/Physics_applications/plasma_mirror/inputs_test_2d_plasma_mirror``.
3939

4040

Examples/Physics_applications/thomson_parabola_spectrometer/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The PICMI input file is not available for this example yet.
2929
For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.
3030

3131
.. literalinclude:: inputs_test_3d_thomson_parabola_spectrometer
32-
:language: ini
32+
:language: none
3333
:caption: You can copy this file from ``Examples/Physics_applications/thomson_parabola_spectrometer/inputs_test_3d_thomson_parabola_spectrometer``.
3434

3535
Visualize
@@ -52,5 +52,5 @@ The :math:`x` coordinate represents the electric deflection, while :math:`y` the
5252
:width: 100%
5353

5454
.. literalinclude:: analysis.py
55-
:language: ini
55+
:language: none
5656
:caption: You can copy this file from ``Examples/Physics_applications/thomson_parabola_spectrometer/analysis.py``.

Examples/Physics_applications/uniform_plasma/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with `
2828
This example can be run **either** as WarpX **executable** using an input file: ``warpx.3d inputs_base_3d``
2929

3030
.. literalinclude:: inputs_base_3d
31-
:language: ini
31+
:language: none
3232
:caption: You can copy this file from ``usage/examples/lwfa/inputs_base_3d``.
3333

3434
.. tab-item:: 2D
@@ -46,7 +46,7 @@ For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with `
4646
This example can be run **either** as WarpX **executable** using an input file: ``warpx.2d inputs_test_2d_uniform_plasma``
4747

4848
.. literalinclude:: inputs_test_2d_uniform_plasma
49-
:language: ini
49+
:language: none
5050
:caption: You can copy this file from ``usage/examples/lwfa/inputs_test_2d_uniform_plasma``.
5151

5252
Analyze

Examples/Tests/field_ionization/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with `
2828
.. tab-item:: Executable: Input File
2929

3030
.. literalinclude:: inputs_test_2d_ionization_lab
31-
:language: ini
31+
:language: none
3232
:caption: You can copy this file from ``Examples/Tests/field_ionization/inputs_test_2d_ionization_lab``.
3333

3434
.. tab-item:: boosted frame
@@ -38,7 +38,7 @@ For `MPI-parallel <https://www.mpi-forum.org>`__ runs, prefix these lines with `
3838
* WarpX **executable** using an input file: ``warpx.2d inputs_test_2d_ionization_boost max_step=420``
3939

4040
.. literalinclude:: inputs_test_2d_ionization_boost
41-
:language: ini
41+
:language: none
4242
:caption: You can copy this file from ``Examples/Tests/field_ionization/inputs_test_2d_ionization_boost``.
4343

4444
Analyze

0 commit comments

Comments
 (0)