automatic import of python-sphinx-airflow-themeopeneuler20.03

3 files changed, 111 insertions, 5 deletions

diff --git a/.gitignore b/.gitignore
index f3162d3..9e3a9ed 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
 /sphinx_airflow_theme-0.0.11.tar.gz
+/sphinx_airflow_theme-0.0.12.tar.gz
diff --git a/python-sphinx-airflow-theme.spec b/python-sphinx-airflow-theme.spec
index 38ad9d1..ef0656e 100644
--- a/python-sphinx-airflow-theme.spec
+++ b/python-sphinx-airflow-theme.spec
@@ -1,11 +1,11 @@
 %global _empty_manifest_terminate_build 0
 Name:		python-sphinx-airflow-theme
-Version:	0.0.11
+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/af/9c/e24597907ee651f294f7f63c24d232323aa554e526a16e9b8736036dfb26/sphinx_airflow_theme-0.0.11.tar.gz
+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
@@ -30,6 +30,41 @@ In order to start working with the theme, please follow the instructions below.
     ```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
@@ -94,6 +129,41 @@ In order to start working with the theme, please follow the instructions below.
     ```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
@@ -155,6 +225,41 @@ In order to start working with the theme, please follow the instructions below.
     ```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
@@ -194,7 +299,7 @@ Controls the ToC display in the sidebar. See https://www.sphinx-doc.org/en/maste
   in** `<ROOT DIRECTORY>/landing-pages/src/docs-index.js
 
 %prep
-%autosetup -n sphinx-airflow-theme-0.0.11
+%autosetup -n sphinx-airflow-theme-0.0.12
 
 %build
 %py3_build
@@ -234,5 +339,5 @@ mv %{buildroot}/doclist.lst .
 %{_docdir}/*
 
 %changelog
-* Wed Apr 12 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.11-1
+* Tue Apr 25 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.12-1
 - Package Spec generated
diff --git a/sources b/sources
index 71f17c8..59b288a 100644
--- a/sources
+++ b/sources
@@ -1 +1 @@
-3622da61e64e34a2bbc3432cfa2e6027  sphinx_airflow_theme-0.0.11.tar.gz
+34ea81d820936a1916c99bb6f61945bc  sphinx_airflow_theme-0.0.12.tar.gz