diff options
author | CoprDistGit <infra@openeuler.org> | 2023-04-10 18:03:40 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-04-10 18:03:40 +0000 |
commit | 44df59493f4d4a48db32ab83687d1087244bf7c5 (patch) | |
tree | b6bb4a32eb678337321612b2ca9c78f7ca3c7a27 | |
parent | 0d500985056e876e4767733687eccfe9d8ef983b (diff) |
automatic import of python-sphinxcontrib-napoleon
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-sphinxcontrib-napoleon.spec | 149 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 151 insertions, 0 deletions
@@ -0,0 +1 @@ +/sphinxcontrib-napoleon-0.7.tar.gz diff --git a/python-sphinxcontrib-napoleon.spec b/python-sphinxcontrib-napoleon.spec new file mode 100644 index 0000000..dd8e460 --- /dev/null +++ b/python-sphinxcontrib-napoleon.spec @@ -0,0 +1,149 @@ +%global _empty_manifest_terminate_build 0 +Name: python-sphinxcontrib-napoleon +Version: 0.7 +Release: 1 +Summary: Sphinx "napoleon" extension. +License: BSD +URL: https://sphinxcontrib-napoleon.readthedocs.io +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/fa/eb/ad89500f4cee83187596e07f43ad561f293e8e6e96996005c3319653b89f/sphinxcontrib-napoleon-0.7.tar.gz +BuildArch: noarch + +Requires: python3-six +Requires: python3-pockets + +%description + Sphinx under `sphinx.ext.napoleon`. The `sphinxcontrib.napoleon` extension + will continue to work with Sphinx <= 1.2. +Are you tired of writing docstrings that look like this:: + instance is destructed +`ReStructuredText`_ is great, but it creates visually dense, hard to read +`docstrings`_. Compare the jumble above to the same thing rewritten +according to the `Google Python Style Guide`_:: + Args: + path (str): The path of the file to wrap + field_storage (FileStorage): The :class:`FileStorage` instance to wrap + temporary (bool): Whether or not to delete the file when the File + instance is destructed + Returns: + BufferedFileStorage: A buffered writable file descriptor +Much more legible, no? +Napoleon is a `Sphinx extension`_ that enables Sphinx to parse both `NumPy`_ +and `Google`_ style docstrings - the style recommended by `Khan Academy`_. +Napoleon is a pre-processor that parses `NumPy`_ and `Google`_ style +docstrings and converts them to reStructuredText before Sphinx attempts to +parse them. This happens in an intermediate step while Sphinx is processing +the documentation, so it doesn't modify any of the docstrings in your actual +source code files. + http://google.github.io/styleguide/pyguide.html + http://google.github.io/styleguide/pyguide.html#Comments + https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt + https://sites.google.com/a/khanacademy.org/forge/for-developers/styleguide/python#TOC-Docstrings + +%package -n python3-sphinxcontrib-napoleon +Summary: Sphinx "napoleon" extension. +Provides: python-sphinxcontrib-napoleon +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-sphinxcontrib-napoleon + Sphinx under `sphinx.ext.napoleon`. The `sphinxcontrib.napoleon` extension + will continue to work with Sphinx <= 1.2. +Are you tired of writing docstrings that look like this:: + instance is destructed +`ReStructuredText`_ is great, but it creates visually dense, hard to read +`docstrings`_. Compare the jumble above to the same thing rewritten +according to the `Google Python Style Guide`_:: + Args: + path (str): The path of the file to wrap + field_storage (FileStorage): The :class:`FileStorage` instance to wrap + temporary (bool): Whether or not to delete the file when the File + instance is destructed + Returns: + BufferedFileStorage: A buffered writable file descriptor +Much more legible, no? +Napoleon is a `Sphinx extension`_ that enables Sphinx to parse both `NumPy`_ +and `Google`_ style docstrings - the style recommended by `Khan Academy`_. +Napoleon is a pre-processor that parses `NumPy`_ and `Google`_ style +docstrings and converts them to reStructuredText before Sphinx attempts to +parse them. This happens in an intermediate step while Sphinx is processing +the documentation, so it doesn't modify any of the docstrings in your actual +source code files. + http://google.github.io/styleguide/pyguide.html + http://google.github.io/styleguide/pyguide.html#Comments + https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt + https://sites.google.com/a/khanacademy.org/forge/for-developers/styleguide/python#TOC-Docstrings + +%package help +Summary: Development documents and examples for sphinxcontrib-napoleon +Provides: python3-sphinxcontrib-napoleon-doc +%description help + Sphinx under `sphinx.ext.napoleon`. The `sphinxcontrib.napoleon` extension + will continue to work with Sphinx <= 1.2. +Are you tired of writing docstrings that look like this:: + instance is destructed +`ReStructuredText`_ is great, but it creates visually dense, hard to read +`docstrings`_. Compare the jumble above to the same thing rewritten +according to the `Google Python Style Guide`_:: + Args: + path (str): The path of the file to wrap + field_storage (FileStorage): The :class:`FileStorage` instance to wrap + temporary (bool): Whether or not to delete the file when the File + instance is destructed + Returns: + BufferedFileStorage: A buffered writable file descriptor +Much more legible, no? +Napoleon is a `Sphinx extension`_ that enables Sphinx to parse both `NumPy`_ +and `Google`_ style docstrings - the style recommended by `Khan Academy`_. +Napoleon is a pre-processor that parses `NumPy`_ and `Google`_ style +docstrings and converts them to reStructuredText before Sphinx attempts to +parse them. This happens in an intermediate step while Sphinx is processing +the documentation, so it doesn't modify any of the docstrings in your actual +source code files. + http://google.github.io/styleguide/pyguide.html + http://google.github.io/styleguide/pyguide.html#Comments + https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt + https://sites.google.com/a/khanacademy.org/forge/for-developers/styleguide/python#TOC-Docstrings + +%prep +%autosetup -n sphinxcontrib-napoleon-0.7 + +%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-napoleon -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7-1 +- Package Spec generated @@ -0,0 +1 @@ +080555f8bcdf5de9819798c24bdd02f8 sphinxcontrib-napoleon-0.7.tar.gz |