summaryrefslogtreecommitdiff
path: root/python-sphinxcontrib-napoleon.spec
blob: dd8e4602dfb8e1a596e7ad5d316c3cde45f6b165 (plain)
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
%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