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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
%global _empty_manifest_terminate_build 0
Name: python-sphinx-airflow-theme
Version: 0.0.12
Release: 1
Summary: Airflow theme for Sphinx
License: Apache License 2.0
URL: https://github.com/apache/airflow-site/tree/aip-11
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/5a/9e/984a8dda20807170cae5779ae702eba80466a5bd54c3ac47672783c92080/sphinx_airflow_theme-0.0.12.tar.gz
BuildArch: noarch
Requires: python3-sphinx
%description
Sphinx theme for Apache Airflow documentation.
# Install from sources
In order to start working with the theme, please follow the instructions below.
1. Make sure your `python` shell command executes Python3 interpreter. If necessary, use a virtual environment:
```
mkvirtualenv -p python3 <name_of_environment>
```
2. To make Javascript and CSS code available for the theme, run the following command in the root directory:
```shell script
./site.sh build-site && ./site.sh prepare-theme
```
3. To install the required Python packages, in `<ROOT DIRECTORY>/sphinx_airflow_theme` run:
```shell script
pip install -e .
```
4. To launch the demo documentation page, in `<ROOT DIRECTORY>/sphinx_airflow_theme/demo` run:
```shell script
./docs.sh build && ./docs.sh preview
```
# Generate Airflow documentation with Sphinx theme changes
If you made some modifications to Sphinx theme and want to generate Airflow documentation to check the end results,
please follow these steps:
1. In `airflow-site` repository, build Airflow website:
```shell script
./site.sh build-site
```
2. Package the Sphinx theme in a `whl` file:
```shell script
cd ./sphinx_airflow_theme
python3 setup.py sdist bdist_wheel
```
3. (Optional) Double-check your modifications to the Sphinx theme are in the `whl` file:
```shell script
pip install wheel
wheel unpack ./sphinx_airflow_theme-0.0.11-py3-none-any.whl
```
4. Copy the `whl` file to `files` directory in `airflow` repository:
```shell script
cp ./sphinx_airflow_theme-0.0.11-py3-none-any.whl ${AIRFLOW_REPO}/files/
```
5. In `airflow` repository, initiate a new breeze environment:
```shell script
breeze
```
6. In the breeze container, generate the documentation after installing the theme:
```shell script
pip install /files/sphinx_airflow_theme-0.0.11-py3-none-any.whl --force-reinstall
# Generate Airflow documentation only. If you need to generate the whole documentation (all providers),
# you can do it using `/opt/airflow/scripts/in_container/run_docs_build.sh`. It takes longer to execute.
/opt/airflow/scripts/in_container/run_docs_build.sh --package-filter apache-airflow
```
7. Verify the documentation generated is correct and includes your modifications. The documentation is generated in
`docs/_build/docs/`. If you generated Airflow documentation only, you can check the results in
`docs/_build/docs/apache-airflow/latest/`.
# Install developer version
To install the latest development version of a theme, run:
```shell script
THEME_VERSION="$(curl -s https://api.github.com/repos/apache/airflow-site/releases/latest | grep '"tag_name":' | cut -d '"' -f 4)"
pip install "https://github.com/apache/airflow-site/releases/download/${THEME_VERSION}/sphinx_airflow_theme-${THEME_VERSION}-py3-none-any.whl"
```
Python packages for your PRs is available as downloadable artifact in GitHub Actions after
the CI builds your PR.
# Configuration
A theme that supports the following configuration options under the `html_theme_options` dict in your projects `conf.py`:
## `navbar_links`
The list of links that should be available in the navigation bar at the top of the pages. The order of items will not be changed.
**Example values:**
```python
html_theme_options = {
'navbar_links': [
{'href': '/docs/', 'text': 'Documentation'}
]
}
```
(This is the default)
## `hide_website_buttons`
If ``True``, all links on the same domain but not pointing to this theme's page (e.g. `/community/`) will be hidden.
**Example values:**
```python
html_theme_options = {
'hide_website_buttons': False,
}
```
## `sidebar_collapse`
## `sidebar_includehidden`
Controls the ToC display in the sidebar. See https://www.sphinx-doc.org/en/master/templating.html#toctree for more info
# Theme's source files
- `<ROOT DIRECTORY>/sphinx_airflow_theme/sphinx_airflow_theme` - HTML files
- `<ROOT DIRECTORY>/landing-pages/site/assets/scss` - SCSS files
- `<ROOT DIRECTORY>/landing-pages/src/js` - Javascript files. If you create a new JS file, **don't forget to include it
in** `<ROOT DIRECTORY>/landing-pages/src/docs-index.js
%package -n python3-sphinx-airflow-theme
Summary: Airflow theme for Sphinx
Provides: python-sphinx-airflow-theme
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-sphinx-airflow-theme
Sphinx theme for Apache Airflow documentation.
# Install from sources
In order to start working with the theme, please follow the instructions below.
1. Make sure your `python` shell command executes Python3 interpreter. If necessary, use a virtual environment:
```
mkvirtualenv -p python3 <name_of_environment>
```
2. To make Javascript and CSS code available for the theme, run the following command in the root directory:
```shell script
./site.sh build-site && ./site.sh prepare-theme
```
3. To install the required Python packages, in `<ROOT DIRECTORY>/sphinx_airflow_theme` run:
```shell script
pip install -e .
```
4. To launch the demo documentation page, in `<ROOT DIRECTORY>/sphinx_airflow_theme/demo` run:
```shell script
./docs.sh build && ./docs.sh preview
```
# Generate Airflow documentation with Sphinx theme changes
If you made some modifications to Sphinx theme and want to generate Airflow documentation to check the end results,
please follow these steps:
1. In `airflow-site` repository, build Airflow website:
```shell script
./site.sh build-site
```
2. Package the Sphinx theme in a `whl` file:
```shell script
cd ./sphinx_airflow_theme
python3 setup.py sdist bdist_wheel
```
3. (Optional) Double-check your modifications to the Sphinx theme are in the `whl` file:
```shell script
pip install wheel
wheel unpack ./sphinx_airflow_theme-0.0.11-py3-none-any.whl
```
4. Copy the `whl` file to `files` directory in `airflow` repository:
```shell script
cp ./sphinx_airflow_theme-0.0.11-py3-none-any.whl ${AIRFLOW_REPO}/files/
```
5. In `airflow` repository, initiate a new breeze environment:
```shell script
breeze
```
6. In the breeze container, generate the documentation after installing the theme:
```shell script
pip install /files/sphinx_airflow_theme-0.0.11-py3-none-any.whl --force-reinstall
# Generate Airflow documentation only. If you need to generate the whole documentation (all providers),
# you can do it using `/opt/airflow/scripts/in_container/run_docs_build.sh`. It takes longer to execute.
/opt/airflow/scripts/in_container/run_docs_build.sh --package-filter apache-airflow
```
7. Verify the documentation generated is correct and includes your modifications. The documentation is generated in
`docs/_build/docs/`. If you generated Airflow documentation only, you can check the results in
`docs/_build/docs/apache-airflow/latest/`.
# Install developer version
To install the latest development version of a theme, run:
```shell script
THEME_VERSION="$(curl -s https://api.github.com/repos/apache/airflow-site/releases/latest | grep '"tag_name":' | cut -d '"' -f 4)"
pip install "https://github.com/apache/airflow-site/releases/download/${THEME_VERSION}/sphinx_airflow_theme-${THEME_VERSION}-py3-none-any.whl"
```
Python packages for your PRs is available as downloadable artifact in GitHub Actions after
the CI builds your PR.
# Configuration
A theme that supports the following configuration options under the `html_theme_options` dict in your projects `conf.py`:
## `navbar_links`
The list of links that should be available in the navigation bar at the top of the pages. The order of items will not be changed.
**Example values:**
```python
html_theme_options = {
'navbar_links': [
{'href': '/docs/', 'text': 'Documentation'}
]
}
```
(This is the default)
## `hide_website_buttons`
If ``True``, all links on the same domain but not pointing to this theme's page (e.g. `/community/`) will be hidden.
**Example values:**
```python
html_theme_options = {
'hide_website_buttons': False,
}
```
## `sidebar_collapse`
## `sidebar_includehidden`
Controls the ToC display in the sidebar. See https://www.sphinx-doc.org/en/master/templating.html#toctree for more info
# Theme's source files
- `<ROOT DIRECTORY>/sphinx_airflow_theme/sphinx_airflow_theme` - HTML files
- `<ROOT DIRECTORY>/landing-pages/site/assets/scss` - SCSS files
- `<ROOT DIRECTORY>/landing-pages/src/js` - Javascript files. If you create a new JS file, **don't forget to include it
in** `<ROOT DIRECTORY>/landing-pages/src/docs-index.js
%package help
Summary: Development documents and examples for sphinx-airflow-theme
Provides: python3-sphinx-airflow-theme-doc
%description help
Sphinx theme for Apache Airflow documentation.
# Install from sources
In order to start working with the theme, please follow the instructions below.
1. Make sure your `python` shell command executes Python3 interpreter. If necessary, use a virtual environment:
```
mkvirtualenv -p python3 <name_of_environment>
```
2. To make Javascript and CSS code available for the theme, run the following command in the root directory:
```shell script
./site.sh build-site && ./site.sh prepare-theme
```
3. To install the required Python packages, in `<ROOT DIRECTORY>/sphinx_airflow_theme` run:
```shell script
pip install -e .
```
4. To launch the demo documentation page, in `<ROOT DIRECTORY>/sphinx_airflow_theme/demo` run:
```shell script
./docs.sh build && ./docs.sh preview
```
# Generate Airflow documentation with Sphinx theme changes
If you made some modifications to Sphinx theme and want to generate Airflow documentation to check the end results,
please follow these steps:
1. In `airflow-site` repository, build Airflow website:
```shell script
./site.sh build-site
```
2. Package the Sphinx theme in a `whl` file:
```shell script
cd ./sphinx_airflow_theme
python3 setup.py sdist bdist_wheel
```
3. (Optional) Double-check your modifications to the Sphinx theme are in the `whl` file:
```shell script
pip install wheel
wheel unpack ./sphinx_airflow_theme-0.0.11-py3-none-any.whl
```
4. Copy the `whl` file to `files` directory in `airflow` repository:
```shell script
cp ./sphinx_airflow_theme-0.0.11-py3-none-any.whl ${AIRFLOW_REPO}/files/
```
5. In `airflow` repository, initiate a new breeze environment:
```shell script
breeze
```
6. In the breeze container, generate the documentation after installing the theme:
```shell script
pip install /files/sphinx_airflow_theme-0.0.11-py3-none-any.whl --force-reinstall
# Generate Airflow documentation only. If you need to generate the whole documentation (all providers),
# you can do it using `/opt/airflow/scripts/in_container/run_docs_build.sh`. It takes longer to execute.
/opt/airflow/scripts/in_container/run_docs_build.sh --package-filter apache-airflow
```
7. Verify the documentation generated is correct and includes your modifications. The documentation is generated in
`docs/_build/docs/`. If you generated Airflow documentation only, you can check the results in
`docs/_build/docs/apache-airflow/latest/`.
# Install developer version
To install the latest development version of a theme, run:
```shell script
THEME_VERSION="$(curl -s https://api.github.com/repos/apache/airflow-site/releases/latest | grep '"tag_name":' | cut -d '"' -f 4)"
pip install "https://github.com/apache/airflow-site/releases/download/${THEME_VERSION}/sphinx_airflow_theme-${THEME_VERSION}-py3-none-any.whl"
```
Python packages for your PRs is available as downloadable artifact in GitHub Actions after
the CI builds your PR.
# Configuration
A theme that supports the following configuration options under the `html_theme_options` dict in your projects `conf.py`:
## `navbar_links`
The list of links that should be available in the navigation bar at the top of the pages. The order of items will not be changed.
**Example values:**
```python
html_theme_options = {
'navbar_links': [
{'href': '/docs/', 'text': 'Documentation'}
]
}
```
(This is the default)
## `hide_website_buttons`
If ``True``, all links on the same domain but not pointing to this theme's page (e.g. `/community/`) will be hidden.
**Example values:**
```python
html_theme_options = {
'hide_website_buttons': False,
}
```
## `sidebar_collapse`
## `sidebar_includehidden`
Controls the ToC display in the sidebar. See https://www.sphinx-doc.org/en/master/templating.html#toctree for more info
# Theme's source files
- `<ROOT DIRECTORY>/sphinx_airflow_theme/sphinx_airflow_theme` - HTML files
- `<ROOT DIRECTORY>/landing-pages/site/assets/scss` - SCSS files
- `<ROOT DIRECTORY>/landing-pages/src/js` - Javascript files. If you create a new JS file, **don't forget to include it
in** `<ROOT DIRECTORY>/landing-pages/src/docs-index.js
%prep
%autosetup -n sphinx-airflow-theme-0.0.12
%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-sphinx-airflow-theme -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 25 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.12-1
- Package Spec generated
|
