Skip to content

Commit 28fee23

Browse files
EmantorEmantor
authored
Merge pull request #1519 from Bastian-Krause/bst/doc-fixes-2024
doc: add support for sphinx_rtd_theme 3.0.0
2 parents f424c0b + 3ef1d2d commit 28fee23

File tree

8 files changed

+55
-84
lines changed

8 files changed

+55
-84
lines changed

‎doc/conf.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,6 @@
9595
#
9696
html_theme = 'sphinx_rtd_theme'
9797

98-
# Set correct html_path for rtd theme:
99-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
100-
10198
# Theme options are theme-specific and customize the look and feel of a theme
10299
# further. For a list of options available for each theme, see the
103100
# documentation.

‎man/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ PAGES := labgrid-client.1 labgrid-coordinator.1 labgrid-exporter.1 labgrid-devic
22
COMPRESSED := labgrid-client.1.gz labgrid-coordinator.1.gz labgrid-exporter.1.gz labgrid-device-config.5.gz labgrid-pytest.7.gz labgrid-suggest.1.gz
33

44
%.1 %.5 %.7: %.rst
5-
rst2man.py $< >$@.tmp
5+
rst2man $< >$@.tmp
66
mv -f $@.tmp $@
77

88
%.gz : %

‎man/labgrid-client.1

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "LABGRID-CLIENT" 1 "2017-04-15" "0.0.1" "embedded testing"
30+
.TH "LABGRID-CLIENT" "1" "2017-04-15" "0.0.1" "embedded testing"
3131
.SH NAME
3232
labgrid-client \- labgrid-client interface to control boards
3333
.SH SYNOPSIS
@@ -247,11 +247,9 @@ To retrieve a list of places run:
247247
.INDENT 0.0
248248
.INDENT 3.5
249249
.sp
250-
.nf
251-
.ft C
250+
.EX
252251
$ labgrid\-client places
253-
.ft P
254-
.fi
252+
.EE
255253
.UNINDENT
256254
.UNINDENT
257255
.sp
@@ -260,35 +258,29 @@ the \fBacquire command\fP and passing the placename as a \-p parameter:
260258
.INDENT 0.0
261259
.INDENT 3.5
262260
.sp
263-
.nf
264-
.ft C
261+
.EX
265262
$ labgrid\-client \-p <placename> acquire
266-
.ft P
267-
.fi
263+
.EE
268264
.UNINDENT
269265
.UNINDENT
270266
.sp
271267
Open a console to the acquired place:
272268
.INDENT 0.0
273269
.INDENT 3.5
274270
.sp
275-
.nf
276-
.ft C
271+
.EX
277272
$ labgrid\-client \-p <placename> console
278-
.ft P
279-
.fi
273+
.EE
280274
.UNINDENT
281275
.UNINDENT
282276
.sp
283277
Add all resources with the group \(dqexample\-group\(dq to the place example\-place:
284278
.INDENT 0.0
285279
.INDENT 3.5
286280
.sp
287-
.nf
288-
.ft C
281+
.EX
289282
$ labgrid\-client \-p example\-place add\-match */example\-group/*/*
290-
.ft P
291-
.fi
283+
.EE
292284
.UNINDENT
293285
.UNINDENT
294286
.SH SEE ALSO

‎man/labgrid-coordinator.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "LABGRID-COORDINATOR" 1 "2024-08-06" "0.0.1" "embedded testing"
30+
.TH "LABGRID-COORDINATOR" "1" "2024-08-06" "0.0.1" "embedded testing"
3131
.SH NAME
3232
labgrid-coordinator \- labgrid-coordinator managing labgrid resources and places
3333
.SH SYNOPSIS

‎man/labgrid-device-config.5

Lines changed: 31 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "LABGRID-DEVICE-CONFIG" 5 "2017-04-15" "0.0.1" "embedded testing"
30+
.TH "LABGRID-DEVICE-CONFIG" "5" "2017-04-15" "0.0.1" "embedded testing"
3131
.SH NAME
3232
labgrid-device-config \- labgrid test configuration files
3333
.SH SYNOPSIS
@@ -49,7 +49,7 @@ important, since they are parsed as an ordered dictionary and may depend on a
4949
previous driver.
5050
.sp
5151
For a list of available resources and drivers refer to
52-
\fI\%https://labgrid.readthedocs.io/en/latest/configuration.html\fP\&.
52+
<https://labgrid.readthedocs.io/en/latest/configuration.html> \&.
5353
.SH OPTIONS
5454
.sp
5555
The \fBoptions:\fP top key configures various options such as the coordinator_address.
@@ -75,13 +75,11 @@ Two configured images, one for the root filesystem, one for the bootloader:
7575
.INDENT 0.0
7676
.INDENT 3.5
7777
.sp
78-
.nf
79-
.ft C
78+
.EX
8079
images:
8180
root: \(dqplatform\-v7a/images/root.img\(dq
8281
boot: \(dqplatform\-v7a/images/barebox.img\(dq
83-
.ft P
84-
.fi
82+
.EE
8583
.UNINDENT
8684
.UNINDENT
8785
.SH TOOLS
@@ -92,91 +90,89 @@ The \fBtools:\fP top key provides paths to binaries such as fastboot.
9290
.TP
9391
.B \fBdfu\-util\fP
9492
Path to the dfu\-util binary, used by the DFUDriver.
95-
See: \fI\%https://dfu\-util.sourceforge.net/\fP
93+
See: <https://dfu\-util.sourceforge.net/>
9694
.TP
9795
.B \fBdpcmd\fP
9896
Path to the dpcmd binary, used by the DediprogFlashDriver.
99-
See: \fI\%https://github.com/DediProgSW/SF100Linux\fP
97+
See: <https://github.com/DediProgSW/SF100Linux>
10098
.TP
10199
.B \fBfastboot\fP
102100
Path to the fastboot binary, used by the AndroidFastbootDriver.
103-
See: \fI\%https://developer.android.com/studio/releases/platform\-tools\fP
101+
See: <https://developer.android.com/studio/releases/platform\-tools>
104102
.TP
105103
.B \fBflashrom\fP
106104
Path to the flashrom binary, used by the FlashromDriver.
107-
See: \fI\%https://www.flashrom.org/\fP
105+
See: <https://www.flashrom.org/>
108106
.TP
109107
.B \fBimx_usb\fP
110108
Path to the imx_usb binary, used by the BDIMXUSBDriver.
111-
See: \fI\%https://github.com/boundarydevices/imx_usb_loader\fP
109+
See: <https://github.com/boundarydevices/imx_usb_loader>
112110
.TP
113111
.B \fBimx\-usb\-loader\fP
114112
Path to the imx\-usb\-loader binary, used by the IMXUSBDriver.
115-
See: \fI\%https://git.pengutronix.de/cgit/barebox/tree/scripts/imx/imx\-usb\-loader.c\fP
113+
See: <https://git.pengutronix.de/cgit/barebox/tree/scripts/imx/imx\-usb\-loader.c>
116114
.TP
117115
.B \fBjtagconfig\fP
118116
Path to the jtagconfig binary, used by the QuartusHPSDriver.
119-
See: \fI\%https://www.intel.com/content/www/us/en/docs/programmable/683689/current/jtagconfig.html\fP
117+
See: <https://www.intel.com/content/www/us/en/docs/programmable/683689/current/jtagconfig.html>
120118
.TP
121119
.B \fBmxs\-usb\-loader\fP
122120
Path to the mxs\-usb\-loader binary, used by the MXSUSBDriver.
123-
See: \fI\%https://git.pengutronix.de/cgit/barebox/tree/scripts/mxs\-usb\-loader.c?h=v2017.03.0\fP
121+
See: <https://git.pengutronix.de/cgit/barebox/tree/scripts/mxs\-usb\-loader.c?h=v2017.03.0>
124122
.TP
125123
.B \fBopenocd\fP
126124
Path to the openocd binary, used by the OpenOCDDriver.
127-
See: \fI\%https://openocd.org/\fP
125+
See: <https://openocd.org/>
128126
.TP
129127
.B \fBquartus_hps\fP
130128
Path to the quartus_hps binary, used by the QuartusHPSDriver.
131-
See: \fI\%https://www.intel.com/content/www/us/en/docs/programmable/683039/22\-3/hps\-flash\-programmer.html\fP
129+
See: <https://www.intel.com/content/www/us/en/docs/programmable/683039/22\-3/hps\-flash\-programmer.html>
132130
.TP
133131
.B \fBrk\-usb\-loader\fP
134132
Path to the rk\-usb\-loader binary, used by the RKUSBDriver.
135-
See: \fI\%https://git.pengutronix.de/cgit/barebox/tree/scripts/rk\-usb\-loader.c\fP
133+
See: <https://git.pengutronix.de/cgit/barebox/tree/scripts/rk\-usb\-loader.c>
136134
.TP
137135
.B \fBsd\-mux\-ctrl\fP
138136
Path to the sd\-mux\-ctrl binary, used by the USBSDWireDriver.
139-
See: \fI\%https://git.tizen.org/cgit/tools/testlab/sd\-mux/\fP
137+
See: <https://git.tizen.org/cgit/tools/testlab/sd\-mux/>
140138
.TP
141139
.B \fBsispmctl\fP
142140
Path to the sispmctl binary, used by the SiSPMPowerDriver.
143-
See: \fI\%https://sispmctl.sourceforge.net/\fP
141+
See: <https://sispmctl.sourceforge.net/>
144142
.TP
145143
.B \fBuhubctl\fP
146144
Path to the uhubctl binary, used by the USBPowerDriver.
147-
See: \fI\%https://github.com/mvp/uhubctl\fP
145+
See: <https://github.com/mvp/uhubctl>
148146
.TP
149147
.B \fBusbmuxctl\fP
150148
Path to the usbmuxctl tool, used by the LXAUSBMuxDriver.
151-
\fI\%https://github.com/linux\-automation/usbmuxctl\fP
149+
<https://github.com/linux\-automation/usbmuxctl>
152150
.TP
153151
.B \fBusbsdmux\fP
154152
Path to the usbsdmux tool, used by the USBSDMuxDriver.
155-
See: \fI\%https://github.com/linux\-automation/usbsdmux\fP
153+
See: <https://github.com/linux\-automation/usbsdmux>
156154
.TP
157155
.B \fBuuu\-loader\fP
158156
Path to the uuu\-loader binary, used by the UUUDriver.
159-
See: \fI\%https://github.com/nxp\-imx/mfgtools\fP
157+
See: <https://github.com/nxp\-imx/mfgtools>
160158
.TP
161159
.B \fBykushcmd\fP
162160
Path to the ykushcmd binary, used by the YKUSHPowerDriver.
163-
See: \fI\%https://github.com/Yepkit/ykush\fP
161+
See: <https://github.com/Yepkit/ykush>
164162
.UNINDENT
165163
.sp
166164
The QEMUDriver expects a custom key set via its \fBqemu_bin\fP argument.
167-
See \fI\%https://www.qemu.org/\fP
165+
See <https://www.qemu.org/>
168166
.SS TOOLS EXAMPLE
169167
.sp
170168
Configure the tool path for \fBimx\-usb\-loader\fP:
171169
.INDENT 0.0
172170
.INDENT 3.5
173171
.sp
174-
.nf
175-
.ft C
172+
.EX
176173
tools:
177174
imx\-usb\-loader: \(dq/opt/labgrid\-helper/imx\-usb\-loader\(dq
178-
.ft P
179-
.fi
175+
.EE
180176
.UNINDENT
181177
.UNINDENT
182178
.SH IMPORTS
@@ -192,12 +188,10 @@ Import a local \fImyfunctions.py\fP file:
192188
.INDENT 0.0
193189
.INDENT 3.5
194190
.sp
195-
.nf
196-
.ft C
191+
.EX
197192
imports:
198193
\- myfunctions.py
199-
.ft P
200-
.fi
194+
.EE
201195
.UNINDENT
202196
.UNINDENT
203197
.SH EXAMPLES
@@ -207,8 +201,7 @@ A sample configuration with one \fImain\fP target, accessible via SerialPort
207201
.INDENT 0.0
208202
.INDENT 3.5
209203
.sp
210-
.nf
211-
.ft C
204+
.EX
212205
targets:
213206
main:
214207
resources:
@@ -220,8 +213,7 @@ targets:
220213
prompt: \(aqroot@\ew+:[^ ]+ \(aq
221214
login_prompt: \(aq login: \(aq
222215
username: \(aqroot\(aq
223-
.ft P
224-
.fi
216+
.EE
225217
.UNINDENT
226218
.UNINDENT
227219
.sp
@@ -231,8 +223,7 @@ in the loaded local python file:
231223
.INDENT 0.0
232224
.INDENT 3.5
233225
.sp
234-
.nf
235-
.ft C
226+
.EX
236227
targets:
237228
main:
238229
resources:
@@ -250,8 +241,7 @@ tools:
250241
imx\-usb\-loader: \(dq/opt/lg\-tools/imx\-usb\-loader\(dq
251242
imports:
252243
\- mystrategy.py
253-
.ft P
254-
.fi
244+
.EE
255245
.UNINDENT
256246
.UNINDENT
257247
.SH SEE ALSO

‎man/labgrid-exporter.1

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "LABGRID-EXPORTER" 1 "2017-04-15" "0.0.1" "embedded testing"
30+
.TH "LABGRID-EXPORTER" "1" "2017-04-15" "0.0.1" "embedded testing"
3131
.SH NAME
3232
labgrid-exporter \- labgrid-exporter interface to control boards
3333
.SH SYNOPSIS
@@ -95,7 +95,7 @@ explicitly set.
9595
.sp
9696
The exporter uses a YAML configuration file which defines groups of related
9797
resources.
98-
See <\fI\%https://labgrid.readthedocs.io/en/latest/configuration.html#exporter\-configuration\fP>
98+
See < <https://labgrid.readthedocs.io/en/latest/configuration.html#exporter\-configuration> >
9999
for more information.
100100
.SH ENVIRONMENT VARIABLES
101101
.sp
@@ -110,23 +110,19 @@ Start the exporter with the configuration file \fImy\-config.yaml\fP:
110110
.INDENT 0.0
111111
.INDENT 3.5
112112
.sp
113-
.nf
114-
.ft C
113+
.EX
115114
$ labgrid\-exporter my\-config.yaml
116-
.ft P
117-
.fi
115+
.EE
118116
.UNINDENT
119117
.UNINDENT
120118
.sp
121119
Same as above, but with name \fBmyname\fP:
122120
.INDENT 0.0
123121
.INDENT 3.5
124122
.sp
125-
.nf
126-
.ft C
123+
.EX
127124
$ labgrid\-exporter \-n myname my\-config.yaml
128-
.ft P
129-
.fi
125+
.EE
130126
.UNINDENT
131127
.UNINDENT
132128
.SH SEE ALSO

‎man/labgrid-pytest.7

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "LABGRID-PYTEST" 7 "2017-04-15" "0.0.1" "embedded testing"
30+
.TH "LABGRID-PYTEST" "7" "2017-04-15" "0.0.1" "embedded testing"
3131
.SH NAME
3232
labgrid-pytest \- labgrid-pytest labgrid integration for pytest
3333
.SH SYNOPSIS
@@ -42,18 +42,16 @@ The labgrid plugin parses the supplied configuration yaml file as described in
4242
\fBlabgrid\-device\-config\fP(5) and allows the usage of the target and environment
4343
fixtures.
4444
The complete documentation is available at
45-
\fI\%https://labgrid.readthedocs.io/en/latest/usage.html#pytest\-plugin\fP\&.
45+
<https://labgrid.readthedocs.io/en/latest/usage.html#pytest\-plugin> \&.
4646
.SH EXAMPLES
4747
.sp
4848
Start tests with \fBmyconfig.yaml\fP and directory \fBtests\fP:
4949
.INDENT 0.0
5050
.INDENT 3.5
5151
.sp
52-
.nf
53-
.ft C
52+
.EX
5453
$ pytest \-\-lg\-env myconfig.yaml tests
55-
.ft P
56-
.fi
54+
.EE
5755
.UNINDENT
5856
.UNINDENT
5957
.SH SEE ALSO

0 commit comments

Comments
 (0)