summaryrefslogtreecommitdiff
path: root/python-rst-include.spec
blob: 5a416e3c702cbfd7545e8b42517f429c4be89c87 (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
%global _empty_manifest_terminate_build 0
Name:		python-rst-include
Version:	2.1.2.2
Release:	1
Summary:	commandline tool to resolve RST File includes
License:	MIT License
URL:		https://github.com/bitranox/rst_include
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/85/4d/ca19c4a0e9e0a0fea07dc21f45eaf7644b1cc0207fb1448076f1daff7339/rst_include-2.1.2.2.tar.gz
BuildArch:	noarch

Requires:	python3-click
Requires:	python3-cli-exit-tools
Requires:	python3-lib-list
Requires:	python3-lib-log-utils
Requires:	python3-pathlib3x

%description
Version v2.1.2.2 as of 2022-06-03 see `Changelog`_
|build_badge| |license| |pypi| |pypi-downloads| |black|
|codecov| |better_code| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
since You can not include files into RST files on github or PyPi, You can resolve such imports with this software.
That means You can locally write Your RST documents (for instance with pycharm) and use there
the *.. include:* option to include other RST Files or code snippets into Your Document.
Afterwards You can run this software to create a monolithic README.rst that can be viewed on Github or Pypi
You might also include Text/Code from Jupyter Notebooks (sorry, no pictures at the moment, but it is not very hard to do that)
This has many advantages like :
- dont repeat Yourself, create standard blocks to include into Your documentation
- include tested code snippets from Your code files into Your documentation, to avoid untested or outdated documentation
- include other RST Files
- very simple usage, throwing exit codes to detect errors on documentation at travis build-time
- commandline or programmatic interface, You can even use it in the travis.yml

%package -n python3-rst-include
Summary:	commandline tool to resolve RST File includes
Provides:	python-rst-include
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-rst-include
Version v2.1.2.2 as of 2022-06-03 see `Changelog`_
|build_badge| |license| |pypi| |pypi-downloads| |black|
|codecov| |better_code| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
since You can not include files into RST files on github or PyPi, You can resolve such imports with this software.
That means You can locally write Your RST documents (for instance with pycharm) and use there
the *.. include:* option to include other RST Files or code snippets into Your Document.
Afterwards You can run this software to create a monolithic README.rst that can be viewed on Github or Pypi
You might also include Text/Code from Jupyter Notebooks (sorry, no pictures at the moment, but it is not very hard to do that)
This has many advantages like :
- dont repeat Yourself, create standard blocks to include into Your documentation
- include tested code snippets from Your code files into Your documentation, to avoid untested or outdated documentation
- include other RST Files
- very simple usage, throwing exit codes to detect errors on documentation at travis build-time
- commandline or programmatic interface, You can even use it in the travis.yml

%package help
Summary:	Development documents and examples for rst-include
Provides:	python3-rst-include-doc
%description help
Version v2.1.2.2 as of 2022-06-03 see `Changelog`_
|build_badge| |license| |pypi| |pypi-downloads| |black|
|codecov| |better_code| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
since You can not include files into RST files on github or PyPi, You can resolve such imports with this software.
That means You can locally write Your RST documents (for instance with pycharm) and use there
the *.. include:* option to include other RST Files or code snippets into Your Document.
Afterwards You can run this software to create a monolithic README.rst that can be viewed on Github or Pypi
You might also include Text/Code from Jupyter Notebooks (sorry, no pictures at the moment, but it is not very hard to do that)
This has many advantages like :
- dont repeat Yourself, create standard blocks to include into Your documentation
- include tested code snippets from Your code files into Your documentation, to avoid untested or outdated documentation
- include other RST Files
- very simple usage, throwing exit codes to detect errors on documentation at travis build-time
- commandline or programmatic interface, You can even use it in the travis.yml

%prep
%autosetup -n rst-include-2.1.2.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-rst-include -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 2.1.2.2-1
- Package Spec generated