[airflow] branch main updated: Add package filter info to Breeze build docs (#18550)

[po...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/main by this push:
     new 892c5fc  Add package filter info to Breeze build docs (#18550)
892c5fc is described below

commit 892c5fcce4a07b61c580e78bef62ab13767edaf6
Author: JavierLopezT <ja...@gmail.com>
AuthorDate: Mon Sep 27 18:42:49 2021 +0200

    Add package filter info to Breeze build docs (#18550)
---
 BREEZE.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/BREEZE.rst b/BREEZE.rst
index 7d999ab..e153aaf 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -750,6 +750,13 @@ extra ``--`` flag.
 
      ./breeze build-docs -- --spellcheck-only
 
+This process can take some time, so in order to make it shorter you can filter by package, using the flag
+``--package-filter <PACKAGE-NAME>``. The package name has to be one of the providers or ``apache-airflow``. For
+instance, for using it with Amazon, the command would be:
+
+.. code-block:: bash
+
+     ./breeze build-docs -- --package-filter apache-airflow-providers-amazon
 
 Often errors during documentation generation come from the docstrings of auto-api generated classes.
 During the docs building auto-api generated files are stored in the ``docs/_api`` folder. This helps you