potiuk commented on code in PR #33207: URL: https://github.com/apache/airflow/pull/33207#discussion_r1287429169
########## BREEZE.rst: ########## @@ -2034,23 +2034,35 @@ To add back references to the documentation generated by ``build-docs`` in Breez use the ``release-management add-back-references`` command. This is important to support backward compatibility the airflow documentation. -.. code-block:: bash - - breeze release-management add-back-references +You have to specify which packages you run it on. For example you can run it for all providers: .. code-block:: bash - release-management add-back-references --airflow-site-directory DIRECTORY + release-management add-back-references --airflow-site-directory DIRECTORY all-providers The flag ``--airflow-site-directory`` takes the path of the cloned ``airflow-site``. The command will not proceed if this is an invalid path. +You can also run the command for apache-airflow (core documentation): + +.. code-block:: bash + + breeze release-management publish-docs --airflow-site-directory DIRECTORY apache-airflow + +Also for helm-chart package: + +.. code-block:: bash + + breeze release-management publish-docs --airflow-site-directory DIRECTORY helm-chart + + +You can also manually specify (it's auto-completable) list of packages to run the command for including individual +providers - you can mix apache-airflow, helm-chart and provider packages this way: + .. code-block:: bash - breeze release-management publish-docs --gen-type [airflow | providers | helm] + breeze release-management publish-docs --airflow-site-directory DIRECTORY apache.airflow apache.beam google Review Comment: No - not here. Copy&pasteable is in the reelase instructions. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
