10000 Workaround GitHub bug rendering reST code blocks · robotframework/robotframework@b7b8c6f · GitHub
[go: up one dir, main page]
Skip to content

Commit b7b8c6f

Browse files
pekkaklarckpekkaklarck
committed
Workaround GitHub bug rendering reST code blocks
See github/markup#1806
1 parent 43c5659 commit b7b8c6f

31 files changed

+332
-332
lines changed

‎INSTALL.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Python version than the one provided by your distribution by default.
4747
To check what Python version you have installed, you can run `python --version`
4848
command in a terminal:
4949

50-
.. sourcecode:: bash
50+
.. code:: bash
5151
5252
$ python --version
5353
Python 3.10.13
@@ -58,7 +58,7 @@ specific command like `python3.8`. You need to use these version specific varian
5858
also if you have multiple Python 3 versions installed and need to pinpoint which
5959
one to use:
6060

61-
.. sourcecode:: bash
61+
.. code:: bash
6262
6363
$ python3.11 --version
6464
Python 3.11.7
@@ -89,7 +89,7 @@ to select the `Add Python 3.x to PATH` checkbox on the first dialog.
8989
To make sure Python installation has been successful and Python has been
9090
added to `PATH`, you can open the command prompt and execute `python --version`:
9191

92-
.. sourcecode:: batch
92+
.. code:: batch
9393
9494
C:\>python --version
9595
Python 3.10.9
@@ -98,7 +98,7 @@ If you install multiple Python versions on Windows, the version that is used
9898
when you execute `python` is the one first in `PATH`. If you need to use others,
9999
the easiest way is using the `py launcher`__:
100100

101-
.. sourcecode:: batch
101+
.. code:: batch
102102
103103
C:\>py --version
104104
Python 3.10.9
@@ -200,7 +200,7 @@ To make sure you have pip available, you can run `pip --version` or equivalent.
200200

201201
Examples on Linux:
202202

203-
.. sourcecode:: bash
203+
.. code:: bash
204204
205205
$ pip --version
206206
pip 23.2.1 from ... (python 3.10)
@@ -209,7 +209,7 @@ Examples on Linux:
209209
210210
Examples on Windows:
211211

212-
.. sourcecode:: batch
212+
.. code:: batch
213213
214214
C:\> pip --version
215215
pip 23.2.1 from ... (python 3.10)
@@ -229,7 +229,7 @@ shown below and pip_ documentation has more information and examples.
229229

230230
__ PyPI_
231231

232-
.. sourcecode:: bash
232+
.. code:: bash
233233
234234
# Install the latest version (does not upgrade)
235235
pip install robotframework
@@ -265,7 +265,7 @@ repository and checking out the needed release tag.
265265

266266
Once you have the source code, you can install it with the following command:
267267

268-
.. sourcecode:: bash
268+
.. code:: bash
269269
270270
python setup.py install
271271
@@ -280,7 +280,7 @@ Verifying installation
280280
To make sure that the correct Robot Framework version has been installed, run
281281
the following command:
282282

283-
.. sourcecode:: bash
283+
.. code:: bash
284284
285285
$ robot --version
286286
Robot Framework 7.0 (Python 3.10.3 on linux)
@@ -294,7 +294,7 @@ running `robot` will execute the one first in PATH_. To select explicitly,
294294
you can run `python -m robot` and substitute `python` with the right Python
295295
version.
296296

297-
.. sourcecode:: bash
297+
.. code:: bash
298298
299299
$ python3.12 -m robot --version
300300
Robot Framework 7.0 (Python 3.12.1 on linux)

‎doc/releasenotes/rf-3.1.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Automatic argument conversion
101101
By default all arguments that are not specified as variables are given to
102102
Python based keywords as Unicode strings. This includes cases like this:
103103

104-
.. sourcecode:: robotframework
104+
.. code:: robotframework
105105
106106
*** Test Cases ***
107107
Example
@@ -114,7 +114,7 @@ then converts arguments to the specified types automatically.
114114
When using Python 3, it is possible to use `function annotations`__ to
115115
explicitly specify types (`#2890`_):
116116

117-
.. sourcecode:: python
117+
.. code:: python
118118
119119
def example_keyword(count: int, case_insensitive: bool = True):
120120
if case_insensitive:
@@ -125,7 +125,7 @@ decorator (`#2947`_) that works also with Python 2. It is possible both
125125
to map argument names to types using a dictionary and to use a list mapping
126126
arguments to types based on position:
127127

128-
.. sourcecode:: python
128+
.. code:: python
129129
130130
@keyword(types={'count': int, 'case_insensitive': bool})
131131
def example_keyword(count, case_insensitive=True):
@@ -140,7 +140,7 @@ arguments to types based on position:
140140
If an argument has no explicit type specified, Robot Framework still tries
141141
to get the type implicitly from an argument default values (`#2932`_):
142142

143-
.. sourcecode:: python
143+
.. code:: python
144144
145145
def example_keyword(count=-1, case_insensitive=True):
146146
if case_insensitive:
@@ -164,13 +164,13 @@ user keywords (`#2896`_), and dynamic libraries (`#2897`_).
164164

165165
With Python 3 libraries this syntax could be used, for example, like this:
166166

167-
.. sourcecode:: python
167+
.. code:: python
168168
169169
def sort_words(*words, case_sensitive=False):
170170
key = str.lower if case_sensitive else None
171171
return sorted(words, key=key)
172172
173-
.. sourcecode:: robotframework
173+
.. code:: robotframework
174174
175175
*** Test Cases ***
176176
Example
@@ -179,7 +179,7 @@ With Python 3 libraries this syntax could be used, for example, like this:
179179
180180
User keywords using the new syntax could look like this:
181181

182-
.. sourcecode:: robotframework
182+
.. code:: robotframework
183183
184184
*** Keywords ***
185185
With Varargs

‎doc/releasenotes/rf-3.1a2.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Automatic argument conversion
106106
By default all arguments that are not specified as variables are given to
107107
Python based keywords as Unicode strings. This includes cases like this:
108108

109-
.. sourcecode:: robotframework
109+
.. code:: robotframework
110110
111111
*** Test Cases ***
112112
Example
@@ -120,7 +120,7 @@ automatically.
120120
When using Python 3, it is possible to use `function annotations`__ to
121121
explicitly specify types (`#2890`_):
122122

123-
.. sourcecode:: python
123+
.. code:: python
124124
125125
def example_keyword(count: int, case_insensitive: bool = True):
126126
if case_insensitive:
@@ -131,7 +131,7 @@ decorator (`#2947`_) that works both with Python 2 and Python 3. It is
131131
possible both to map argument names to types using a dictionary and to
132132
use a list mapping arguments to types based on position:
133133

134-
.. sourcecode:: python
134+
.. code:: python
135135
136136
@keyword(types={'count': int, 'case_insensitive': bool})
137137
def example_keyword(count, case_insensitive=True):
@@ -146,7 +146,7 @@ use a list mapping arguments to types based on position:
146146
If an argument has no explicit type specified, Robot Framework still tries
147147
to get the type implicitly from an argument default values (`#2932`_):
148148

149-
.. sourcecode:: python
149+
.. code:: python
150150
151151
def example_keyword(count=-1, case_insensitive=True):
152152
if case_insensitive:
@@ -164,13 +164,13 @@ user keywords (`#2896`_), and with dynamic libraries (`#2897`_).
164164

165165
With Python 3 libraries this syntax could be used, for example, like this:
166166

167-
.. sourcecode:: python
167+
.. code:: python
168168
169169
def sort_words(*words, case_sensitive=False):
170170
key = str.lower if case_sensitive else None
171171
return sorted(words, key=key)
172172
173-
.. sourcecode:: robotframework
173+
.. code:: robotframework
174174
175175
*** Test Cases ***
176176
Example
@@ -179,7 +179,7 @@ With Python 3 libraries this syntax could be used, for example, like this:
179179
180180
User keywords using the new syntax could look like this:
181181

182-
.. sourcecode:: robotframework
182+
.. code:: robotframework
183183
184184
*** Keywords ***
185185
With Varargs

‎doc/releasenotes/rf-3.1b1.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Automatic argument conversion
104104
By default all arguments that are not specified as variables are given to
105105
Python based keywords as Unicode strings. This includes cases like this:
106106

107-
.. sourcecode:: robotframework
107+
.. code:: robotframework
108108
109109
*** Test Cases ***
110110
Example
@@ -117,7 +117,7 @@ then converts arguments to the specified types automatically.
117117
When using Python 3, it is possible to use `function annotations`__ to
118118
explicitly specify types (`#2890`_):
119119

120-
.. sourcecode:: python
120+
.. code:: python
121121
122122
def example_keyword(count: int, case_insensitive: bool = True):
123123
if case_insensitive:
@@ -128,7 +128,7 @@ decorator (`#2947`_) that works also with Python 2. It is possible both
128128
to map argument names to types using a dictionary and to use a list mapping
129129
arguments to types based on position:
130130

131-
.. sourcecode:: python
131+
.. code:: python
132132
133133
@keyword(types={'count': int, 'case_insensitive': bool})
134134
def example_keyword(count, case_insensitive=True):
@@ -143,7 +143,7 @@ arguments to types based on position:
143143
If an argument has no explicit type specified, Robot Framework still tries
144144
to get the type implicitly from an argument default values (`#2932`_):
145145

146-
.. sourcecode:: python
146+
.. code:: python
147147
148148
def example_keyword(count=-1, case_insensitive=True):
149149
if case_insensitive:
@@ -161,13 +161,13 @@ user keywords (`#2896`_), and with dynamic libraries (`#2897`_).
161161

162162
With Python 3 libraries this syntax could be used, for example, like this:
163163

164-
.. sourcecode:: python
164+
.. code:: python
165165
166166
def sort_words(*words, case_sensitive=False):
167167
key = str.lower if case_sensitive else None
168168
return sorted(words, key=key)
169169
170-
.. sourcecode:: robotframework
170+
.. code:: robotframework
171171
172172
*** Test Cases ***
173173
Example
@@ -176,7 +176,7 @@ With Python 3 libraries this syntax could be used, for example, like this:
176176
177177
User keywords using the new syntax could look like this:
178178

179-
.. sourcecode:: robotframework
179+
.. code:: robotframework
180180
181181
*** Keywords ***
182182
With Varargs

‎doc/releasenotes/rf-3.1rc1.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Automatic argument conversion
103103
By default all arguments that are not specified as variables are given to
104104
Python based keywords as Unicode strings. This includes cases like this:
105105

106-
.. sourcecode:: robotframework
106+
.. code:: robotframework
107107
108108
*** Test Cases ***
109109
Example
@@ -116,7 +116,7 @@ then converts arguments to the specified types automatically.
116116
When using Python 3, it is possible to use `function annotations`__ to
117117
explicitly specify types (`#2890`_):
118118

119-
.. sourcecode:: python
119+
.. code:: python
120120
121121
def example_keyword(count: int, case_insensitive: bool = True):
122122
if case_insensitive:
@@ -127,7 +127,7 @@ decorator (`#2947`_) that works also with Python 2. It is possible both
127127
to map argument names to types using a dictionary and to use a list mapping
128128
arguments to types based on position:
129129

130-
.. sourcecode:: python
130+
.. code:: python
131131
132132
@keyword(types={'count': int, 'case_insensitive': bool})
133133
def example_keyword(count, case_insensitive=True):
@@ -142,7 +142,7 @@ arguments to types based on position:
142142
If an argument has no explicit type specified, Robot Framework still tries
143143
to get the type implicitly from an argument default values (`#2932`_):
144144

145-
.. sourcecode:: python
145+
.. code:: python
146146
147147
def example_keyword(count=-1, case_insensitive=True):
148148
if case_insensitive:
@@ -166,13 +166,13 @@ user keywords (`#2896`_), and dynamic libraries (`#2897`_).
166166

167167
With Python 3 libraries this syntax could be used, for example, like this:
168168

169-
.. sourcecode:: python
169+
.. code:: python
170170
171171
def sort_words(*words, case_sensitive=False):
172172
key = str.lower if case_sensitive else None
173173
return sorted(words, key=key)
174174
175-
.. sourcecode:: robotframework
175+
.. code:: robotframework
176176
177177
*** Test Cases ***
178178
Example
@@ -181,7 +181,7 @@ With Python 3 libraries this syntax could be used, for example, like this:
181181
182182
User keywords using the new syntax could look like this:
183183

184-
.. sourcecode:: robotframework
184+
.. code:: robotframework
185185
186186
*** Keywords ***
187187
With Varargs

‎doc/releasenotes/rf-3.1rc2.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Automatic argument conversion
105105
By default all arguments that are not specified as variables are given to
106106
Python based keywords as Unicode strings. This includes cases like this:
107107

108-
.. sourcecode:: robotframework
108+
.. code:: robotframework
109109
110110
*** Test Cases ***
111111
Example
@@ -118,7 +118,7 @@ then converts arguments to the specified types automatically.
118118
When using Python 3, it is possible to use `function annotations`__ to
119119
explicitly specify types (`#2890`_):
120120

121-
.. sourcecode:: python
121+
.. code:: python
122122
123123
def example_keyword(count: int, case_insensitive: bool = True):
124124
if case_insensitive:
@@ -129,7 +129,7 @@ decorator (`#2947`_) that works also with Python 2. It is possible both
129129
to map argument names to types using a dictionary and to use a list mapping
130130
arguments to types based on position:
131131

132-
.. sourcecode:: python
132+
.. code:: python
133133
134134
@keyword(types={'count': int, 'case_insensitive': bool})
135135
def example_keyword(count, case_insensitive=True):
@@ -144,7 +144,7 @@ arguments to types based on position:
144144
If an argument has no explicit type specified, Robot Framework still tries
145145
to get the type implicitly from an argument default values (`#2932`_):
146146

147-
.. sourcecode:: python
147+
.. code:: python
148148
149149
def example_keyword(count=-1, case_insensitive=True):
150150
if case_insensitive:
@@ -168,13 +168,13 @@ user keywords (`#2896`_), and dynamic libraries (`#2897`_).
168168

169169
With Python 3 libraries this syntax could be used, for example, like this:
170170

171-
.. sourcecode:: python
171+
.. code:: python
172172
173173
def sort_words(*words, case_sensitive=False):
174174
key = str.lower if case_sensitive else None
175175
return sorted(words, key=key)
176176
177-
.. sourcecode:: robotframework
177+
.. code:: robotframework
178178
179179
*** Test Cases ***
180180
Example
@@ -183,7 +183,7 @@ With Python 3 libraries this syntax could be used, for example, like this:
183183
184184
User keywords using the new syntax could look like this:
185185

186-
.. sourcecode:: robotframework
186+
.. code:: robotframework
187187
188188
*** Keywords ***
189189
With Varargs

0 commit comments

Comments
 (0)
0