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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
%global _empty_manifest_terminate_build 0
Name: python-sphinx-autodoc-defaultargs
Version: 0.1.2
Release: 1
Summary: Automatic generation of default arguments for the Sphinx autodoc extension.
License: MIT
URL: https://pypi.org/project/sphinx-autodoc-defaultargs/
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/1a/7c/8edb5d817ebeb146073be629ed58f89b292a643ee111bee3c703be05a7a1/sphinx-autodoc-defaultargs-0.1.2.tar.gz
BuildArch: noarch
Requires: python3-Sphinx
Requires: python3-pytest
Requires: python3-typing-extensions
Requires: python3-sphobjinv
Requires: python3-Sphinx
Requires: python3-dataclasses
Requires: python3-typed-ast
%description
# sphinx-autodoc-defaultargs
[](https://pypi.org/project/sphinx-autodoc-defaultargs/)
[](https://github.com/zwang123/sphinx-autodoc-defaultargs/actions/workflows/python-package.yml)
[](https://coveralls.io/github/zwang123/sphinx-autodoc-defaultargs?branch=main)
[](https://github.com/zwang123/sphinx-autodoc-defaultargs/blob/main/LICENSE)
[](https://pypi.org/project/sphinx-autodoc-defaultargs/)
## Overview
This extension automatically generates default arguments for the Sphinx autodoc extension.
## Example
With this package, the default values of all documented arguments, and undocumented arguments if enabled,
are automatically detected and added to the docstring.
It also detects existing documentation of default arguments with the text unchanged.
```python
def func(x=None, y=None):
"""
Example docstring.
:param x: The default value ``None`` will be added here.
:param y: The text of default value is unchanged.
(Default: ``'Default Value'``)
"""
if y is None:
y = 'Default Value'
...
```
## Installation
### pip
If you use `pip`, you can install the package with:
```bash
python -m pip install sphinx_autodoc_defaultargs
```
### setup.py
In the root directory, run the following command in the terminal.
```bash
python setup.py install
```
## Usage
Add the extension as well as the global substitution to the `conf.py` file:
```python
extensions = [
'sphinx.ext.autodoc',
'sphinx_autodoc_defaultargs'
]
rst_prolog = """
.. |default| raw:: html
<div class="default-value-section">""" + \
' <span class="default-value-label">Default:</span>'
```
Note that it should be loaded after [sphinx.ext.napoleon](http://www.sphinx-doc.org/en/stable/ext/napoleon.html).
## Config Options
* `always_document_default_args` (default: `False`):
If False, do not add info of default arguments for undocumented parameters.
If True, add stub documentation for undocumented parameters
to be able to add default value and to flag `optional` in the type.
* `docstring_default_arg_flags` (default: `[('(Default: ', ')')]`):
List of pairs indicating the header and the footer of an existing documentation of default values,
which is expected at the end of the `param` section.
If detected, it will be replaced by the unified style but the text should remain unchanged.
* `docstring_default_arg_after_directives` (default: `False`):
If True, the default value will be added after all
[directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html)
(e.g., note, warning).
Existing documentation of the default value is also expected after these directives.
Otherwise, it will be added, and expected to exist, before these directives.
* `docstring_default_arg_substitution` (default: `'|default|'`):
The substitution markup defined in the `conf.py` file.
%package -n python3-sphinx-autodoc-defaultargs
Summary: Automatic generation of default arguments for the Sphinx autodoc extension.
Provides: python-sphinx-autodoc-defaultargs
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-sphinx-autodoc-defaultargs
# sphinx-autodoc-defaultargs
[](https://pypi.org/project/sphinx-autodoc-defaultargs/)
[](https://github.com/zwang123/sphinx-autodoc-defaultargs/actions/workflows/python-package.yml)
[](https://coveralls.io/github/zwang123/sphinx-autodoc-defaultargs?branch=main)
[](https://github.com/zwang123/sphinx-autodoc-defaultargs/blob/main/LICENSE)
[](https://pypi.org/project/sphinx-autodoc-defaultargs/)
## Overview
This extension automatically generates default arguments for the Sphinx autodoc extension.
## Example
With this package, the default values of all documented arguments, and undocumented arguments if enabled,
are automatically detected and added to the docstring.
It also detects existing documentation of default arguments with the text unchanged.
```python
def func(x=None, y=None):
"""
Example docstring.
:param x: The default value ``None`` will be added here.
:param y: The text of default value is unchanged.
(Default: ``'Default Value'``)
"""
if y is None:
y = 'Default Value'
...
```
## Installation
### pip
If you use `pip`, you can install the package with:
```bash
python -m pip install sphinx_autodoc_defaultargs
```
### setup.py
In the root directory, run the following command in the terminal.
```bash
python setup.py install
```
## Usage
Add the extension as well as the global substitution to the `conf.py` file:
```python
extensions = [
'sphinx.ext.autodoc',
'sphinx_autodoc_defaultargs'
]
rst_prolog = """
.. |default| raw:: html
<div class="default-value-section">""" + \
' <span class="default-value-label">Default:</span>'
```
Note that it should be loaded after [sphinx.ext.napoleon](http://www.sphinx-doc.org/en/stable/ext/napoleon.html).
## Config Options
* `always_document_default_args` (default: `False`):
If False, do not add info of default arguments for undocumented parameters.
If True, add stub documentation for undocumented parameters
to be able to add default value and to flag `optional` in the type.
* `docstring_default_arg_flags` (default: `[('(Default: ', ')')]`):
List of pairs indicating the header and the footer of an existing documentation of default values,
which is expected at the end of the `param` section.
If detected, it will be replaced by the unified style but the text should remain unchanged.
* `docstring_default_arg_after_directives` (default: `False`):
If True, the default value will be added after all
[directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html)
(e.g., note, warning).
Existing documentation of the default value is also expected after these directives.
Otherwise, it will be added, and expected to exist, before these directives.
* `docstring_default_arg_substitution` (default: `'|default|'`):
The substitution markup defined in the `conf.py` file.
%package help
Summary: Development documents and examples for sphinx-autodoc-defaultargs
Provides: python3-sphinx-autodoc-defaultargs-doc
%description help
# sphinx-autodoc-defaultargs
[](https://pypi.org/project/sphinx-autodoc-defaultargs/)
[](https://github.com/zwang123/sphinx-autodoc-defaultargs/actions/workflows/python-package.yml)
[](https://coveralls.io/github/zwang123/sphinx-autodoc-defaultargs?branch=main)
[](https://github.com/zwang123/sphinx-autodoc-defaultargs/blob/main/LICENSE)
[](https://pypi.org/project/sphinx-autodoc-defaultargs/)
## Overview
This extension automatically generates default arguments for the Sphinx autodoc extension.
## Example
With this package, the default values of all documented arguments, and undocumented arguments if enabled,
are automatically detected and added to the docstring.
It also detects existing documentation of default arguments with the text unchanged.
```python
def func(x=None, y=None):
"""
Example docstring.
:param x: The default value ``None`` will be added here.
:param y: The text of default value is unchanged.
(Default: ``'Default Value'``)
"""
if y is None:
y = 'Default Value'
...
```
## Installation
### pip
If you use `pip`, you can install the package with:
```bash
python -m pip install sphinx_autodoc_defaultargs
```
### setup.py
In the root directory, run the following command in the terminal.
```bash
python setup.py install
```
## Usage
Add the extension as well as the global substitution to the `conf.py` file:
```python
extensions = [
'sphinx.ext.autodoc',
'sphinx_autodoc_defaultargs'
]
rst_prolog = """
.. |default| raw:: html
<div class="default-value-section">""" + \
' <span class="default-value-label">Default:</span>'
```
Note that it should be loaded after [sphinx.ext.napoleon](http://www.sphinx-doc.org/en/stable/ext/napoleon.html).
## Config Options
* `always_document_default_args` (default: `False`):
If False, do not add info of default arguments for undocumented parameters.
If True, add stub documentation for undocumented parameters
to be able to add default value and to flag `optional` in the type.
* `docstring_default_arg_flags` (default: `[('(Default: ', ')')]`):
List of pairs indicating the header and the footer of an existing documentation of default values,
which is expected at the end of the `param` section.
If detected, it will be replaced by the unified style but the text should remain unchanged.
* `docstring_default_arg_after_directives` (default: `False`):
If True, the default value will be added after all
[directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html)
(e.g., note, warning).
Existing documentation of the default value is also expected after these directives.
Otherwise, it will be added, and expected to exist, before these directives.
* `docstring_default_arg_substitution` (default: `'|default|'`):
The substitution markup defined in the `conf.py` file.
%prep
%autosetup -n sphinx-autodoc-defaultargs-0.1.2
%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-sphinx-autodoc-defaultargs -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.2-1
- Package Spec generated
|
