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
258
259
260
261
262
263
264
265
|
%global _empty_manifest_terminate_build 0
Name: python-KB4IT
Version: 0.7.8
Release: 1
Summary: A static website generator based on Asciidoctor sources.
License: GPL v3
URL: https://github.com/t00m/KB4IT
Source0: https://mirrors.aliyun.com/pypi/web/packages/6f/4d/8a1ab9bd2f3cc69d9051f25ffd23a0725bdc93a58e6b684d7230f34dd871/KB4IT-0.7.8.tar.gz
BuildArch: noarch
Requires: python3-mako
%description
Introduction
^^^^^^^^^^^^
*KB4IT* is a static website generator based on Asciidoctor sources mainly
for technical documentation purposes.
You can see some demos here: https://github.com/t00m/kb4it-adocs
Motivations
^^^^^^^^^^^
- The main aim is to provide an easy way to write my technical documentation.
- Don't care about the formatting and focus on the contents.
- To allow teams to manage their knowledge database easily.
- Do not depend on third software products like word processors or complex web applications.
Features
^^^^^^^^
Pros
""""
- Writing documentation: Documents must be in Asciidoctor format which is easy to learn.
- Finding documents: Once a document is converted to html, properties can be browsed. Moreover, property pages have filters and a search entry to filter by title.
- Publishing your repository: all necessary files are inside a directory. Browse it or copy it to your web server.
- Serverless: There is no need for a web server. Of course, you can use one if you please.
- Smart compiling: Only those documents added or modified are compiled.
- Use the default themes or build your own custom theme
- By modifying templates, it might be integrated with Github or Gitlab.
Cons
""""
- Not to much documentation at this moment
- No online editor: At this moment, KB4IT doesn't include any online editor. You must create or edit your documents with your preferred editor.
- No dynamic search: KB4IT was developed to be as simple as possible.
- No dependencies at all excepting Asciidoctor (as text processor and publishing toolchain) and Python (the programming language used).
- API is not stable
- Most of the requirements are tailored to my own necessities which might not be the same as yours.
Installation
^^^^^^^^^^^^
From source
"""""""""""
If you have used this app before, it might be necessary to uninstall it before:
``pip3 uninstall kb4it -qy``
Then, install it:
``python3 setup.py install --user``
Pypi package
""""""""""""
``pip3 install kb4it --user -U``
Execution
^^^^^^^^^
The most typical usage would be:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory -log DEBUG``
If templates remain the same, force a new compilation:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory --log DEBUG -force``
If the directory containing the asciidoctor sources have a theme, it will be used. However, you can specify one:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory -theme mytheme -log DEBUG``
You can also specify any_datetime_attribute to sort your documents:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory -sort Published -log DEBUG``
Download
^^^^^^^^
Get the code from Github: https://github.com/t00m/KB4IT
``git clone https://github.com/t00m/KB4IT``
Credits
^^^^^^^
- `Python <http://www.python.org/>`_ Programming language that lets you work more quickly and integrate your systems more effectively.
- `Asciidoctor <https://asciidoctor.org>`_ A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more.
- `UIKit <https://getuikit.com>`_ A lightweight and modular front-end framework for developing fast and powerful web interfaces.
- `Geany <https://www.geany.org/>`_ Powerful, stable and lightweight programmer's text editor that provides tons of useful features without bogging down your workflow. It runs on Linux, Windows and MacOS is translated into over 40 languages, and has built-in support for more than 50 programming languages.
Contact
^^^^^^^
Tomás Vírseda (aka t00m): tomasvirseda@gmail.com
*I would appreciate to hear from your comments.*
%package -n python3-KB4IT
Summary: A static website generator based on Asciidoctor sources.
Provides: python-KB4IT
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-KB4IT
Introduction
^^^^^^^^^^^^
*KB4IT* is a static website generator based on Asciidoctor sources mainly
for technical documentation purposes.
You can see some demos here: https://github.com/t00m/kb4it-adocs
Motivations
^^^^^^^^^^^
- The main aim is to provide an easy way to write my technical documentation.
- Don't care about the formatting and focus on the contents.
- To allow teams to manage their knowledge database easily.
- Do not depend on third software products like word processors or complex web applications.
Features
^^^^^^^^
Pros
""""
- Writing documentation: Documents must be in Asciidoctor format which is easy to learn.
- Finding documents: Once a document is converted to html, properties can be browsed. Moreover, property pages have filters and a search entry to filter by title.
- Publishing your repository: all necessary files are inside a directory. Browse it or copy it to your web server.
- Serverless: There is no need for a web server. Of course, you can use one if you please.
- Smart compiling: Only those documents added or modified are compiled.
- Use the default themes or build your own custom theme
- By modifying templates, it might be integrated with Github or Gitlab.
Cons
""""
- Not to much documentation at this moment
- No online editor: At this moment, KB4IT doesn't include any online editor. You must create or edit your documents with your preferred editor.
- No dynamic search: KB4IT was developed to be as simple as possible.
- No dependencies at all excepting Asciidoctor (as text processor and publishing toolchain) and Python (the programming language used).
- API is not stable
- Most of the requirements are tailored to my own necessities which might not be the same as yours.
Installation
^^^^^^^^^^^^
From source
"""""""""""
If you have used this app before, it might be necessary to uninstall it before:
``pip3 uninstall kb4it -qy``
Then, install it:
``python3 setup.py install --user``
Pypi package
""""""""""""
``pip3 install kb4it --user -U``
Execution
^^^^^^^^^
The most typical usage would be:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory -log DEBUG``
If templates remain the same, force a new compilation:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory --log DEBUG -force``
If the directory containing the asciidoctor sources have a theme, it will be used. However, you can specify one:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory -theme mytheme -log DEBUG``
You can also specify any_datetime_attribute to sort your documents:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory -sort Published -log DEBUG``
Download
^^^^^^^^
Get the code from Github: https://github.com/t00m/KB4IT
``git clone https://github.com/t00m/KB4IT``
Credits
^^^^^^^
- `Python <http://www.python.org/>`_ Programming language that lets you work more quickly and integrate your systems more effectively.
- `Asciidoctor <https://asciidoctor.org>`_ A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more.
- `UIKit <https://getuikit.com>`_ A lightweight and modular front-end framework for developing fast and powerful web interfaces.
- `Geany <https://www.geany.org/>`_ Powerful, stable and lightweight programmer's text editor that provides tons of useful features without bogging down your workflow. It runs on Linux, Windows and MacOS is translated into over 40 languages, and has built-in support for more than 50 programming languages.
Contact
^^^^^^^
Tomás Vírseda (aka t00m): tomasvirseda@gmail.com
*I would appreciate to hear from your comments.*
%package help
Summary: Development documents and examples for KB4IT
Provides: python3-KB4IT-doc
%description help
Introduction
^^^^^^^^^^^^
*KB4IT* is a static website generator based on Asciidoctor sources mainly
for technical documentation purposes.
You can see some demos here: https://github.com/t00m/kb4it-adocs
Motivations
^^^^^^^^^^^
- The main aim is to provide an easy way to write my technical documentation.
- Don't care about the formatting and focus on the contents.
- To allow teams to manage their knowledge database easily.
- Do not depend on third software products like word processors or complex web applications.
Features
^^^^^^^^
Pros
""""
- Writing documentation: Documents must be in Asciidoctor format which is easy to learn.
- Finding documents: Once a document is converted to html, properties can be browsed. Moreover, property pages have filters and a search entry to filter by title.
- Publishing your repository: all necessary files are inside a directory. Browse it or copy it to your web server.
- Serverless: There is no need for a web server. Of course, you can use one if you please.
- Smart compiling: Only those documents added or modified are compiled.
- Use the default themes or build your own custom theme
- By modifying templates, it might be integrated with Github or Gitlab.
Cons
""""
- Not to much documentation at this moment
- No online editor: At this moment, KB4IT doesn't include any online editor. You must create or edit your documents with your preferred editor.
- No dynamic search: KB4IT was developed to be as simple as possible.
- No dependencies at all excepting Asciidoctor (as text processor and publishing toolchain) and Python (the programming language used).
- API is not stable
- Most of the requirements are tailored to my own necessities which might not be the same as yours.
Installation
^^^^^^^^^^^^
From source
"""""""""""
If you have used this app before, it might be necessary to uninstall it before:
``pip3 uninstall kb4it -qy``
Then, install it:
``python3 setup.py install --user``
Pypi package
""""""""""""
``pip3 install kb4it --user -U``
Execution
^^^^^^^^^
The most typical usage would be:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory -log DEBUG``
If templates remain the same, force a new compilation:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory --log DEBUG -force``
If the directory containing the asciidoctor sources have a theme, it will be used. However, you can specify one:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory -theme mytheme -log DEBUG``
You can also specify any_datetime_attribute to sort your documents:
``$HOME/.local/bin/kb4it -source /path/to/asciidoctor/sources -target /path/to/target/directory -sort Published -log DEBUG``
Download
^^^^^^^^
Get the code from Github: https://github.com/t00m/KB4IT
``git clone https://github.com/t00m/KB4IT``
Credits
^^^^^^^
- `Python <http://www.python.org/>`_ Programming language that lets you work more quickly and integrate your systems more effectively.
- `Asciidoctor <https://asciidoctor.org>`_ A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more.
- `UIKit <https://getuikit.com>`_ A lightweight and modular front-end framework for developing fast and powerful web interfaces.
- `Geany <https://www.geany.org/>`_ Powerful, stable and lightweight programmer's text editor that provides tons of useful features without bogging down your workflow. It runs on Linux, Windows and MacOS is translated into over 40 languages, and has built-in support for more than 50 programming languages.
Contact
^^^^^^^
Tomás Vírseda (aka t00m): tomasvirseda@gmail.com
*I would appreciate to hear from your comments.*
%prep
%autosetup -n KB4IT-0.7.8
%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-KB4IT -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7.8-1
- Package Spec generated
|
