automatic import of python-sphinx-autodoc-defaultargs

3 files changed, 366 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index e69de29..374bdde 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/sphinx-autodoc-defaultargs-0.1.2.tar.gz
diff --git a/python-sphinx-autodoc-defaultargs.spec b/python-sphinx-autodoc-defaultargs.spec
new file mode 100644
index 0000000..e713147
--- /dev/null
+++ b/python-sphinx-autodoc-defaultargs.spec
@@ -0,0 +1,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
+
+[![PyPi Version](https://img.shields.io/pypi/v/sphinx-autodoc-defaultargs)](https://pypi.org/project/sphinx-autodoc-defaultargs/)
+[![Build Status](https://github.com/zwang123/sphinx-autodoc-defaultargs/actions/workflows/python-package.yml/badge.svg)](https://github.com/zwang123/sphinx-autodoc-defaultargs/actions/workflows/python-package.yml)
+[![Coverage Status](https://coveralls.io/repos/github/zwang123/sphinx-autodoc-defaultargs/badge.svg?branch=main)](https://coveralls.io/github/zwang123/sphinx-autodoc-defaultargs?branch=main)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/zwang123/sphinx-autodoc-defaultargs/blob/main/LICENSE)
+[![Python Versions](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-informational)](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
+
+[![PyPi Version](https://img.shields.io/pypi/v/sphinx-autodoc-defaultargs)](https://pypi.org/project/sphinx-autodoc-defaultargs/)
+[![Build Status](https://github.com/zwang123/sphinx-autodoc-defaultargs/actions/workflows/python-package.yml/badge.svg)](https://github.com/zwang123/sphinx-autodoc-defaultargs/actions/workflows/python-package.yml)
+[![Coverage Status](https://coveralls.io/repos/github/zwang123/sphinx-autodoc-defaultargs/badge.svg?branch=main)](https://coveralls.io/github/zwang123/sphinx-autodoc-defaultargs?branch=main)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/zwang123/sphinx-autodoc-defaultargs/blob/main/LICENSE)
+[![Python Versions](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-informational)](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
+
+[![PyPi Version](https://img.shields.io/pypi/v/sphinx-autodoc-defaultargs)](https://pypi.org/project/sphinx-autodoc-defaultargs/)
+[![Build Status](https://github.com/zwang123/sphinx-autodoc-defaultargs/actions/workflows/python-package.yml/badge.svg)](https://github.com/zwang123/sphinx-autodoc-defaultargs/actions/workflows/python-package.yml)
+[![Coverage Status](https://coveralls.io/repos/github/zwang123/sphinx-autodoc-defaultargs/badge.svg?branch=main)](https://coveralls.io/github/zwang123/sphinx-autodoc-defaultargs?branch=main)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/zwang123/sphinx-autodoc-defaultargs/blob/main/LICENSE)
+[![Python Versions](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-informational)](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
diff --git a/sources b/sources
new file mode 100644
index 0000000..c6a5111
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+5d7a7652961fb51e5e4bd632e5cc3940  sphinx-autodoc-defaultargs-0.1.2.tar.gz