1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
%global _empty_manifest_terminate_build 0
Name: python-sphinxcontrib-runcmd
Version: 0.2.0
Release: 1
Summary: Sphinx "runcmd" extension
License: MIT
URL: https://github.com/invenia/sphinxcontrib-runcmd
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/a2/03/6eb30814c9839f36131284a46ec9fc39d7bd356078648bc7125d5d1c05e8/sphinxcontrib-runcmd-0.2.0.tar.gz
BuildArch: noarch
Requires: python3-sphinx
Requires: python3-coverage
Requires: python3-pytest
Requires: python3-pytest-cov
Requires: python3-sphinx-testing
%description
# SphinxContrib RunCmd
[](https://travis-ci.org/invenia/sphinxcontrib-runcmd?branch=master)
[](https://coveralls.io/github/invenia/sphinxcontrib-runcmd)
[](https://pypi.org/project/sphinxcontrib-runcmd)
[](https://www.python.org/)
[](https://github.com/ambv/black)
Sphinx RunCmd aims to allow you to place the output of arbitrary commands in your rst files, while also giving you greater flexibility in how the output is formatted.
## Installation
sphinxcontrib-runcmd is available on PyPI. To install:
```sh
$ pip install sphinxcontrib-runcmd
```
## Add runcmd to your Project
First you'll want to add `sphinxcontrib.runcmd` to your `conf.py` file in your docs folder:
```python
extensions = ["sphinxcontrib.runcmd"]
```
From there, all you need to do is use `runcmd` as a directive in your documentation files.
```rst
.. runcmd:: python script.py -h
:syntax: bash
:prompt:
```
## Options
This directive is basically a sub-directive of `code-block`, so it has all of code blocks directives such as:
- linenos
- dedent
- lineno-start
- emphasize-lines
- caption
- class
- name
This directive builds upon that and adds the following:
- syntax: str
- Since we're using the arguments section for a command we can't actually pass the syntax we want to the `code-block` in the arguments. Therefore you can set it in the options which will then get passed into the `code-block` to colorize your commands output.
- replace: str
- Takes in a comma separated list of regex `pattern/replace,pattern/replace` and applies it to the output in that order.
- prompt: bool
- Display the command prompt in the output
- dedent-output: int
- Will dedent the output only by the int value you specify. Will not dedent the prompt if specified. Be careful, because the `code-block` dedent will be applied on top of this dedent if both are set in the options.
### Replace Option
The `replace` option uses the `CSV` package to parse the string, thus you can wrap your replacements in double quotes if you want to use commas and whatnot.
You also need to double escape any forward slashes, but you can single escape quotes.
```rst
.. runcmd:: python test.py -h
:replace: "this\\/is\\/a\\/path/now\\/its\\/another\\/path","\"/'"
```
The first replacement will replace `this/is/a/path` with `now/its/another/path`.
The second replacement will replace `"` with `'`.
## License
sphinxcontrib-runcmd is provided under an MIT License.
%package -n python3-sphinxcontrib-runcmd
Summary: Sphinx "runcmd" extension
Provides: python-sphinxcontrib-runcmd
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-sphinxcontrib-runcmd
# SphinxContrib RunCmd
[](https://travis-ci.org/invenia/sphinxcontrib-runcmd?branch=master)
[](https://coveralls.io/github/invenia/sphinxcontrib-runcmd)
[](https://pypi.org/project/sphinxcontrib-runcmd)
[](https://www.python.org/)
[](https://github.com/ambv/black)
Sphinx RunCmd aims to allow you to place the output of arbitrary commands in your rst files, while also giving you greater flexibility in how the output is formatted.
## Installation
sphinxcontrib-runcmd is available on PyPI. To install:
```sh
$ pip install sphinxcontrib-runcmd
```
## Add runcmd to your Project
First you'll want to add `sphinxcontrib.runcmd` to your `conf.py` file in your docs folder:
```python
extensions = ["sphinxcontrib.runcmd"]
```
From there, all you need to do is use `runcmd` as a directive in your documentation files.
```rst
.. runcmd:: python script.py -h
:syntax: bash
:prompt:
```
## Options
This directive is basically a sub-directive of `code-block`, so it has all of code blocks directives such as:
- linenos
- dedent
- lineno-start
- emphasize-lines
- caption
- class
- name
This directive builds upon that and adds the following:
- syntax: str
- Since we're using the arguments section for a command we can't actually pass the syntax we want to the `code-block` in the arguments. Therefore you can set it in the options which will then get passed into the `code-block` to colorize your commands output.
- replace: str
- Takes in a comma separated list of regex `pattern/replace,pattern/replace` and applies it to the output in that order.
- prompt: bool
- Display the command prompt in the output
- dedent-output: int
- Will dedent the output only by the int value you specify. Will not dedent the prompt if specified. Be careful, because the `code-block` dedent will be applied on top of this dedent if both are set in the options.
### Replace Option
The `replace` option uses the `CSV` package to parse the string, thus you can wrap your replacements in double quotes if you want to use commas and whatnot.
You also need to double escape any forward slashes, but you can single escape quotes.
```rst
.. runcmd:: python test.py -h
:replace: "this\\/is\\/a\\/path/now\\/its\\/another\\/path","\"/'"
```
The first replacement will replace `this/is/a/path` with `now/its/another/path`.
The second replacement will replace `"` with `'`.
## License
sphinxcontrib-runcmd is provided under an MIT License.
%package help
Summary: Development documents and examples for sphinxcontrib-runcmd
Provides: python3-sphinxcontrib-runcmd-doc
%description help
# SphinxContrib RunCmd
[](https://travis-ci.org/invenia/sphinxcontrib-runcmd?branch=master)
[](https://coveralls.io/github/invenia/sphinxcontrib-runcmd)
[](https://pypi.org/project/sphinxcontrib-runcmd)
[](https://www.python.org/)
[](https://github.com/ambv/black)
Sphinx RunCmd aims to allow you to place the output of arbitrary commands in your rst files, while also giving you greater flexibility in how the output is formatted.
## Installation
sphinxcontrib-runcmd is available on PyPI. To install:
```sh
$ pip install sphinxcontrib-runcmd
```
## Add runcmd to your Project
First you'll want to add `sphinxcontrib.runcmd` to your `conf.py` file in your docs folder:
```python
extensions = ["sphinxcontrib.runcmd"]
```
From there, all you need to do is use `runcmd` as a directive in your documentation files.
```rst
.. runcmd:: python script.py -h
:syntax: bash
:prompt:
```
## Options
This directive is basically a sub-directive of `code-block`, so it has all of code blocks directives such as:
- linenos
- dedent
- lineno-start
- emphasize-lines
- caption
- class
- name
This directive builds upon that and adds the following:
- syntax: str
- Since we're using the arguments section for a command we can't actually pass the syntax we want to the `code-block` in the arguments. Therefore you can set it in the options which will then get passed into the `code-block` to colorize your commands output.
- replace: str
- Takes in a comma separated list of regex `pattern/replace,pattern/replace` and applies it to the output in that order.
- prompt: bool
- Display the command prompt in the output
- dedent-output: int
- Will dedent the output only by the int value you specify. Will not dedent the prompt if specified. Be careful, because the `code-block` dedent will be applied on top of this dedent if both are set in the options.
### Replace Option
The `replace` option uses the `CSV` package to parse the string, thus you can wrap your replacements in double quotes if you want to use commas and whatnot.
You also need to double escape any forward slashes, but you can single escape quotes.
```rst
.. runcmd:: python test.py -h
:replace: "this\\/is\\/a\\/path/now\\/its\\/another\\/path","\"/'"
```
The first replacement will replace `this/is/a/path` with `now/its/another/path`.
The second replacement will replace `"` with `'`.
## License
sphinxcontrib-runcmd is provided under an MIT License.
%prep
%autosetup -n sphinxcontrib-runcmd-0.2.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-sphinxcontrib-runcmd -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 25 2023 Python_Bot <Python_Bot@openeuler.org> - 0.2.0-1
- Package Spec generated
|
