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
|
%global _empty_manifest_terminate_build 0
Name: python-mkdocs-versioning
Version: 0.4.0
Release: 1
Summary: A tool that allows for versioning sites built with mkdocs
License: MIT License
URL: https://github.com/zayd62/mkdocs-versioning
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/4e/cc/dcf46d17aac81b557fc66b8f62257079bb063917105e2504a04e1b000f32/mkdocs-versioning-0.4.0.tar.gz
BuildArch: noarch
Requires: python3-PyYAML
Requires: python3-mkdocs
%description
# mkdocs-versioning
`mkdocs-versioning` is a plugin for [mkdocs](https://www.mkdocs.org/), a tool designed to create static websites usually for generating project documentation.
`mkdocs-versioning` extends mkdocs by differentiating between different versions of documentation you may build. For example, a newer versions of some software may work differently from an older version and it is important that users of an older version of the software reads the appropriate version of the documentation in order to ensure that the user has the correct information and uses the software appropriately.
## Setup
Install the plugin using pip:
```bash
pip install mkdocs-versioning
```
Next, add the following lines to your `mkdocs.yml`:
```yml
plugins:
- search
- mkdocs-versioning:
version: 0.3.0
```
> If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set.
## Usage
Instructions on how to use the plugin is available at https://zayd62.github.io/mkdocs-versioning/
## Contributing
Please note that mkdocs-versioning is currently in **Beta** and there may be missing feature/documentation so if you could help out by either:
1. finding and reporting bugs
2. contributing by checking out the [issues](https://github.com/zayd62/mkdocs-versioning/issues)
## Troubleshooting
### Combined use of awesome-pages and mkdocs-versioning
In case of using [awesome-pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/) the order of registration within the `plugins` is important. The following error may occur:
```
Traceback (most recent call last):
[...]
File "/path/to/mkversion/entry.py", line 47, on_config
for count, i in enumerate(nav):
TypeError: 'NoneType' object is not iterable
```
You need to make sure, that the `awesome-pages` plugin is register **after** `mkdocs-versioning`:
```yaml
plugins:
- mkdocs-versioning:
version: "1.0"
- awesome-pages
````
%package -n python3-mkdocs-versioning
Summary: A tool that allows for versioning sites built with mkdocs
Provides: python-mkdocs-versioning
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mkdocs-versioning
# mkdocs-versioning
`mkdocs-versioning` is a plugin for [mkdocs](https://www.mkdocs.org/), a tool designed to create static websites usually for generating project documentation.
`mkdocs-versioning` extends mkdocs by differentiating between different versions of documentation you may build. For example, a newer versions of some software may work differently from an older version and it is important that users of an older version of the software reads the appropriate version of the documentation in order to ensure that the user has the correct information and uses the software appropriately.
## Setup
Install the plugin using pip:
```bash
pip install mkdocs-versioning
```
Next, add the following lines to your `mkdocs.yml`:
```yml
plugins:
- search
- mkdocs-versioning:
version: 0.3.0
```
> If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set.
## Usage
Instructions on how to use the plugin is available at https://zayd62.github.io/mkdocs-versioning/
## Contributing
Please note that mkdocs-versioning is currently in **Beta** and there may be missing feature/documentation so if you could help out by either:
1. finding and reporting bugs
2. contributing by checking out the [issues](https://github.com/zayd62/mkdocs-versioning/issues)
## Troubleshooting
### Combined use of awesome-pages and mkdocs-versioning
In case of using [awesome-pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/) the order of registration within the `plugins` is important. The following error may occur:
```
Traceback (most recent call last):
[...]
File "/path/to/mkversion/entry.py", line 47, on_config
for count, i in enumerate(nav):
TypeError: 'NoneType' object is not iterable
```
You need to make sure, that the `awesome-pages` plugin is register **after** `mkdocs-versioning`:
```yaml
plugins:
- mkdocs-versioning:
version: "1.0"
- awesome-pages
````
%package help
Summary: Development documents and examples for mkdocs-versioning
Provides: python3-mkdocs-versioning-doc
%description help
# mkdocs-versioning
`mkdocs-versioning` is a plugin for [mkdocs](https://www.mkdocs.org/), a tool designed to create static websites usually for generating project documentation.
`mkdocs-versioning` extends mkdocs by differentiating between different versions of documentation you may build. For example, a newer versions of some software may work differently from an older version and it is important that users of an older version of the software reads the appropriate version of the documentation in order to ensure that the user has the correct information and uses the software appropriately.
## Setup
Install the plugin using pip:
```bash
pip install mkdocs-versioning
```
Next, add the following lines to your `mkdocs.yml`:
```yml
plugins:
- search
- mkdocs-versioning:
version: 0.3.0
```
> If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set.
## Usage
Instructions on how to use the plugin is available at https://zayd62.github.io/mkdocs-versioning/
## Contributing
Please note that mkdocs-versioning is currently in **Beta** and there may be missing feature/documentation so if you could help out by either:
1. finding and reporting bugs
2. contributing by checking out the [issues](https://github.com/zayd62/mkdocs-versioning/issues)
## Troubleshooting
### Combined use of awesome-pages and mkdocs-versioning
In case of using [awesome-pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/) the order of registration within the `plugins` is important. The following error may occur:
```
Traceback (most recent call last):
[...]
File "/path/to/mkversion/entry.py", line 47, on_config
for count, i in enumerate(nav):
TypeError: 'NoneType' object is not iterable
```
You need to make sure, that the `awesome-pages` plugin is register **after** `mkdocs-versioning`:
```yaml
plugins:
- mkdocs-versioning:
version: "1.0"
- awesome-pages
````
%prep
%autosetup -n mkdocs-versioning-0.4.0
%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-mkdocs-versioning -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.0-1
- Package Spec generated
|
