@@ -46,6 +46,52 @@ In order to start working with the theme, please follow the instructions below.
46
46
./docs.sh build && ./docs.sh preview
47
47
```
48
48
49
+ # Generate Airflow documentation with Sphinx theme changes
50
+
51
+ If you made some modifications to Sphinx theme and want to generate Airflow documentation to check the end results,
52
+ please follow these steps:
53
+
54
+ 1. In `airflow-site` repository, build Airflow website:
55
+ ```shell script
56
+ ./site.sh build-site
57
+ ```
58
+
59
+ 2. Package the Sphinx theme in a `whl` file:
60
+ ```shell script
61
+ cd ./sphinx_airflow_theme
62
+ python3 setup.py sdist bdist_wheel
63
+ ```
64
+
65
+ 3. (Optional) Double-check your modifications to the Sphinx theme are in the `whl` file:
66
+ ```shell script
67
+ pip install wheel
68
+ wheel unpack ./sphinx_airflow_theme-0.0.11-py3-none-any.whl
69
+ ```
70
+
71
+ 4. Copy the `whl` file to `files` directory in `airflow` repository:
72
+ ```shell script
73
+ cp ./sphinx_airflow_theme-0.0.11-py3-none-any.whl ${AIRFLOW_REPO}/files/
74
+ ```
75
+
76
+ 5. In `airflow` repository, initiate a new breeze environment:
77
+ ```shell script
78
+ breeze
79
+ ```
80
+
81
+ 6. In the breeze container, generate the documentation after installing the theme:
82
+ ```shell script
83
+ pip install /files/sphinx_airflow_theme-0.0.11-py3-none-any.whl --force-reinstall
84
+ # Generate Airflow documentation only. If you need to generate the whole documentation (all providers),
85
+ # you can do it using `/opt/airflow/scripts/in_container/run_docs_build.sh`. It takes longer to execute.
86
+ /opt/airflow/scripts/in_container/run_docs_build.sh --package-filter apache-airflow
87
+ ```
88
+
89
+ 7. Verify the documentation generated is correct and includes your modifications. The documentation is generated in
90
+ `docs/_build/docs/`. If you generated Airflow documentation only, you can check the results in
91
+ `docs/_build/docs/apache-airflow/latest/`.
92
+
93
+
94
+
49
95
# Install developer version
50
96
51
97
To install the latest development version of a theme, run:
0 commit comments