You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "utkarsharma2 (via GitHub)" <gi...@apache.org> on 2023/10/19 16:46:04 UTC

Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]

utkarsharma2 commented on code in PR #35045:
URL: https://github.com/apache/airflow/pull/35045#discussion_r1365844502


##########
docs/README.rst:
##########
@@ -53,11 +53,11 @@ or just to run documentation building
 
      breeze build-docs --docs-only
 
-Also, you can only build one documentation via ``--package-filter``.
+Also, you can only build documentation for a subset of packages via ``--package-filter``. For example, to build documentation only for the main Airflow package and the Kubernetes provider package, you can run the following command:
 
 .. code-block:: bash
 
-    breeze build-docs --package-filter <PACKAGE-NAME>
+    breeze build-docs --package-filter apache-airflow --package-filter apache-airflow-providers-cncf-kubernetes

Review Comment:
   This example was much needed :)



-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org