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
|
%global _empty_manifest_terminate_build 0
Name: python-mkdocs-nav-enhancements
Version: 0.9.1
Release: 1
Summary: This is a small plugin for the excellent MkDocs project which makes some enhancements to the navigation.
License: MIT
URL: https://github.com/rylon/mkdocs-nav-enhancements
Source0: https://mirrors.aliyun.com/pypi/web/packages/13/1b/07a6df922832bf13df3aaed03b9dfc24b2defe97668fbe3b5c75a8551916/mkdocs-nav-enhancements-0.9.1.tar.gz
BuildArch: noarch
Requires: python3-mkdocs
%description
# MkDocs Nav Enhancements
This is a small plugin for the excellent [MkDocs](https://www.mkdocs.org) project which makes some enhancements to the navigation.
## Features
### Enhanced titles
By default, MkDocs looks for a level 1 atx-style header found at the top of the document and uses that for the page title.
If you are dealing with documentation from third-party sources you may find that some of them start their titles at level 2 (possibly for aesthetic reasons), or use setext-style headers instead.
This plugin will try to help by looking through each Markdown document and using the following rules to detect a page title instead:
* Use the first atx-style header found in the document at any level between 1 to 6, which is any line beginning with between 1 to 6 '#' characters.
* Or use the first setext-style header, which is any line where the line immediately after contains only '=' or '-' characters, effectively 'underlining' the line.
It will also remove any additional markup that is found in the title, such as image or link tags, which would otherwise be rendered as string literals in the generated HTML.
### Reduced folders
In order to de-clutter the navigation, the plugin looks for any sections containing only one page, and tries to collapse that page up a level into its parent. This helps deal with navigation bars filled with single-page folders to keep things looking tidy.
## Usage
Install the plugin:
```bash
pip install mkdocs-nav-enhancements
```
Add the plugin to your `mkdocs.yml` [MkDocs configuration](https://www.mkdocs.org/user-guide/configuration/) file:
```yaml
plugins:
- mkdocs-nav-enhancements
```
## Known issues
When changing the page title, or collapsing single-page folders, this can sometimes result in the effective page title being quite different. Currently this plugin does not re-sort the nav bar alphabetically when this happens.
A second issue is that these options are not independently controllable, at least not in the first version; it's all or nothing for now!
## Contributing
Source code is hosted at [GitHub](https://github.com/Rylon/mkdocs-nav-enhancements).
Please report issues and feature requests on [GitHub Issues](https://github.com/Rylon/mkdocs-nav-enhancements).
Pull Requests are also welcome!
%package -n python3-mkdocs-nav-enhancements
Summary: This is a small plugin for the excellent MkDocs project which makes some enhancements to the navigation.
Provides: python-mkdocs-nav-enhancements
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mkdocs-nav-enhancements
# MkDocs Nav Enhancements
This is a small plugin for the excellent [MkDocs](https://www.mkdocs.org) project which makes some enhancements to the navigation.
## Features
### Enhanced titles
By default, MkDocs looks for a level 1 atx-style header found at the top of the document and uses that for the page title.
If you are dealing with documentation from third-party sources you may find that some of them start their titles at level 2 (possibly for aesthetic reasons), or use setext-style headers instead.
This plugin will try to help by looking through each Markdown document and using the following rules to detect a page title instead:
* Use the first atx-style header found in the document at any level between 1 to 6, which is any line beginning with between 1 to 6 '#' characters.
* Or use the first setext-style header, which is any line where the line immediately after contains only '=' or '-' characters, effectively 'underlining' the line.
It will also remove any additional markup that is found in the title, such as image or link tags, which would otherwise be rendered as string literals in the generated HTML.
### Reduced folders
In order to de-clutter the navigation, the plugin looks for any sections containing only one page, and tries to collapse that page up a level into its parent. This helps deal with navigation bars filled with single-page folders to keep things looking tidy.
## Usage
Install the plugin:
```bash
pip install mkdocs-nav-enhancements
```
Add the plugin to your `mkdocs.yml` [MkDocs configuration](https://www.mkdocs.org/user-guide/configuration/) file:
```yaml
plugins:
- mkdocs-nav-enhancements
```
## Known issues
When changing the page title, or collapsing single-page folders, this can sometimes result in the effective page title being quite different. Currently this plugin does not re-sort the nav bar alphabetically when this happens.
A second issue is that these options are not independently controllable, at least not in the first version; it's all or nothing for now!
## Contributing
Source code is hosted at [GitHub](https://github.com/Rylon/mkdocs-nav-enhancements).
Please report issues and feature requests on [GitHub Issues](https://github.com/Rylon/mkdocs-nav-enhancements).
Pull Requests are also welcome!
%package help
Summary: Development documents and examples for mkdocs-nav-enhancements
Provides: python3-mkdocs-nav-enhancements-doc
%description help
# MkDocs Nav Enhancements
This is a small plugin for the excellent [MkDocs](https://www.mkdocs.org) project which makes some enhancements to the navigation.
## Features
### Enhanced titles
By default, MkDocs looks for a level 1 atx-style header found at the top of the document and uses that for the page title.
If you are dealing with documentation from third-party sources you may find that some of them start their titles at level 2 (possibly for aesthetic reasons), or use setext-style headers instead.
This plugin will try to help by looking through each Markdown document and using the following rules to detect a page title instead:
* Use the first atx-style header found in the document at any level between 1 to 6, which is any line beginning with between 1 to 6 '#' characters.
* Or use the first setext-style header, which is any line where the line immediately after contains only '=' or '-' characters, effectively 'underlining' the line.
It will also remove any additional markup that is found in the title, such as image or link tags, which would otherwise be rendered as string literals in the generated HTML.
### Reduced folders
In order to de-clutter the navigation, the plugin looks for any sections containing only one page, and tries to collapse that page up a level into its parent. This helps deal with navigation bars filled with single-page folders to keep things looking tidy.
## Usage
Install the plugin:
```bash
pip install mkdocs-nav-enhancements
```
Add the plugin to your `mkdocs.yml` [MkDocs configuration](https://www.mkdocs.org/user-guide/configuration/) file:
```yaml
plugins:
- mkdocs-nav-enhancements
```
## Known issues
When changing the page title, or collapsing single-page folders, this can sometimes result in the effective page title being quite different. Currently this plugin does not re-sort the nav bar alphabetically when this happens.
A second issue is that these options are not independently controllable, at least not in the first version; it's all or nothing for now!
## Contributing
Source code is hosted at [GitHub](https://github.com/Rylon/mkdocs-nav-enhancements).
Please report issues and feature requests on [GitHub Issues](https://github.com/Rylon/mkdocs-nav-enhancements).
Pull Requests are also welcome!
%prep
%autosetup -n mkdocs-nav-enhancements-0.9.1
%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-nav-enhancements -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.9.1-1
- Package Spec generated
|
