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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
%global _empty_manifest_terminate_build 0
Name: python-teedoc
Version: 1.33.3
Release: 1
Summary: doc site generator with multiple doc support
License: MIT
URL: https://github.com/Neutree/teedoc
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/a6/d1/da1090e46af7d300dad0352c4655712d92d7b275bde89ad43ac0c3ec17ab/teedoc-1.33.3.tar.gz
BuildArch: noarch
Requires: python3-PyYaml
Requires: python3-babel
Requires: python3-coloredlogs
Requires: python3-flask
Requires: python3-html2text
Requires: python3-jinja2
Requires: python3-mistune
Requires: python3-nbconvert
Requires: python3-progress
Requires: python3-requests
Requires: python3-watchdog
%description
[中文](./README_ZH.md) | English
[](./LICENSE) [](https://pypi.org/project/teedoc/#history)   [](https://github.com/teedoc/teedoc/actions/workflows/test.yml) [](https://github.com/teedoc/teedoc)
<img src="https://teedoc.github.io/static/image/logo.png" height=64/>
Official site: [teedoc.neucrack.com](https://teedoc.neucrack.com) or [teedoc.github.io](https://teedoc.github.io/)
More demo: see [here](https://teedoc.neucrack.com/get_started/zh/usage/sites.html) or [here](https://teedoc.github.io/get_started/zh/usage/sites.html)
documentation generate tool from markdown and jupyter notebook to html
`teedoc` can be used in the following scenarios:
* Build a document website, and it is best to support multiple documents and custom pages
* Organizations' or companies' docs spread in different domains, wish to combine them to one site(domain)
* Build a `WiKi` website
* Build personal or corporate knowledge base
* Build personal or corporate website
## Features
- [x] Easy to use, cross platform, only need `Python3`
- [x] Easy to deploy, only copy generated staitc HTML files to your server or other host
- [x] Easy to write, markdown support
- [x] Jupyter notebook support
- [x] Multiple docs support
- [x] Plugin support
- [x] Multiple theme support(support by plugin)
- [x] Control the style accurate to the page through css (implemented by customizing the id and class of each page)
- [x] Multi-level directory support
- [x] Multi-language support (manual translation) (Internationalization/i18n)
- [x] Multilingual support (translation plugin)
- [x] Multiple version support
- [x] Search support
- [x] SEO friendly
- [x] Real-time preview file changes
- [x] Parallel build, faster build speed
- [x] Blog support
- [x] Jinja2 HTML layout template support
## Get Started
Visit official site: [teedoc.github.io](https://teedoc.github.io/) or [teedoc.neucrack.com](https://teedoc.neucrack.com/)
## Create your website on github pages in minutes
See [template repo](https://github.com/teedoc/template)
## Quik start
* Install python3
On `Windows` or `macOS`, download from [python.org](https://www.python.org/downloads/)
On `Linux`, `Ubuntu` for example:
```
sudo apt install python3 python3-pip
```
* Install teedoc
This command will **install teedoc program**
```
pip3 install -U teedoc
```
* Initialize document
```
mkdir my_site
cd my_site
teedoc init
```
or
```
teedoc -d my_site init
```
> select minimal template in promot
* Install plugins
This command will **install plugins** used by doc(set in `site_config.json`)
```
cd my_site
teedoc install
```
* build or serve
```
teedoc serve
```
then visit [http://127.0.0.1:2333](http://127.0.0.1:2333) in browser
If you only want to generate htmls:
```
teedoc build
```
%package -n python3-teedoc
Summary: doc site generator with multiple doc support
Provides: python-teedoc
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-teedoc
[中文](./README_ZH.md) | English
[](./LICENSE) [](https://pypi.org/project/teedoc/#history)   [](https://github.com/teedoc/teedoc/actions/workflows/test.yml) [](https://github.com/teedoc/teedoc)
<img src="https://teedoc.github.io/static/image/logo.png" height=64/>
Official site: [teedoc.neucrack.com](https://teedoc.neucrack.com) or [teedoc.github.io](https://teedoc.github.io/)
More demo: see [here](https://teedoc.neucrack.com/get_started/zh/usage/sites.html) or [here](https://teedoc.github.io/get_started/zh/usage/sites.html)
documentation generate tool from markdown and jupyter notebook to html
`teedoc` can be used in the following scenarios:
* Build a document website, and it is best to support multiple documents and custom pages
* Organizations' or companies' docs spread in different domains, wish to combine them to one site(domain)
* Build a `WiKi` website
* Build personal or corporate knowledge base
* Build personal or corporate website
## Features
- [x] Easy to use, cross platform, only need `Python3`
- [x] Easy to deploy, only copy generated staitc HTML files to your server or other host
- [x] Easy to write, markdown support
- [x] Jupyter notebook support
- [x] Multiple docs support
- [x] Plugin support
- [x] Multiple theme support(support by plugin)
- [x] Control the style accurate to the page through css (implemented by customizing the id and class of each page)
- [x] Multi-level directory support
- [x] Multi-language support (manual translation) (Internationalization/i18n)
- [x] Multilingual support (translation plugin)
- [x] Multiple version support
- [x] Search support
- [x] SEO friendly
- [x] Real-time preview file changes
- [x] Parallel build, faster build speed
- [x] Blog support
- [x] Jinja2 HTML layout template support
## Get Started
Visit official site: [teedoc.github.io](https://teedoc.github.io/) or [teedoc.neucrack.com](https://teedoc.neucrack.com/)
## Create your website on github pages in minutes
See [template repo](https://github.com/teedoc/template)
## Quik start
* Install python3
On `Windows` or `macOS`, download from [python.org](https://www.python.org/downloads/)
On `Linux`, `Ubuntu` for example:
```
sudo apt install python3 python3-pip
```
* Install teedoc
This command will **install teedoc program**
```
pip3 install -U teedoc
```
* Initialize document
```
mkdir my_site
cd my_site
teedoc init
```
or
```
teedoc -d my_site init
```
> select minimal template in promot
* Install plugins
This command will **install plugins** used by doc(set in `site_config.json`)
```
cd my_site
teedoc install
```
* build or serve
```
teedoc serve
```
then visit [http://127.0.0.1:2333](http://127.0.0.1:2333) in browser
If you only want to generate htmls:
```
teedoc build
```
%package help
Summary: Development documents and examples for teedoc
Provides: python3-teedoc-doc
%description help
[中文](./README_ZH.md) | English
[](./LICENSE) [](https://pypi.org/project/teedoc/#history)   [](https://github.com/teedoc/teedoc/actions/workflows/test.yml) [](https://github.com/teedoc/teedoc)
<img src="https://teedoc.github.io/static/image/logo.png" height=64/>
Official site: [teedoc.neucrack.com](https://teedoc.neucrack.com) or [teedoc.github.io](https://teedoc.github.io/)
More demo: see [here](https://teedoc.neucrack.com/get_started/zh/usage/sites.html) or [here](https://teedoc.github.io/get_started/zh/usage/sites.html)
documentation generate tool from markdown and jupyter notebook to html
`teedoc` can be used in the following scenarios:
* Build a document website, and it is best to support multiple documents and custom pages
* Organizations' or companies' docs spread in different domains, wish to combine them to one site(domain)
* Build a `WiKi` website
* Build personal or corporate knowledge base
* Build personal or corporate website
## Features
- [x] Easy to use, cross platform, only need `Python3`
- [x] Easy to deploy, only copy generated staitc HTML files to your server or other host
- [x] Easy to write, markdown support
- [x] Jupyter notebook support
- [x] Multiple docs support
- [x] Plugin support
- [x] Multiple theme support(support by plugin)
- [x] Control the style accurate to the page through css (implemented by customizing the id and class of each page)
- [x] Multi-level directory support
- [x] Multi-language support (manual translation) (Internationalization/i18n)
- [x] Multilingual support (translation plugin)
- [x] Multiple version support
- [x] Search support
- [x] SEO friendly
- [x] Real-time preview file changes
- [x] Parallel build, faster build speed
- [x] Blog support
- [x] Jinja2 HTML layout template support
## Get Started
Visit official site: [teedoc.github.io](https://teedoc.github.io/) or [teedoc.neucrack.com](https://teedoc.neucrack.com/)
## Create your website on github pages in minutes
See [template repo](https://github.com/teedoc/template)
## Quik start
* Install python3
On `Windows` or `macOS`, download from [python.org](https://www.python.org/downloads/)
On `Linux`, `Ubuntu` for example:
```
sudo apt install python3 python3-pip
```
* Install teedoc
This command will **install teedoc program**
```
pip3 install -U teedoc
```
* Initialize document
```
mkdir my_site
cd my_site
teedoc init
```
or
```
teedoc -d my_site init
```
> select minimal template in promot
* Install plugins
This command will **install plugins** used by doc(set in `site_config.json`)
```
cd my_site
teedoc install
```
* build or serve
```
teedoc serve
```
then visit [http://127.0.0.1:2333](http://127.0.0.1:2333) in browser
If you only want to generate htmls:
```
teedoc build
```
%prep
%autosetup -n teedoc-1.33.3
%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-teedoc -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.33.3-1
- Package Spec generated
|
