You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by ka...@apache.org on 2020/12/10 13:16:05 UTC
[airflow] 01/01: Fix command to filter package provider when
building docs
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch fix-command
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit bd577cff115881dc2f88e1bbfb2bbfa7d97c3269
Author: Kaxil Naik <ka...@gmail.com>
AuthorDate: Thu Dec 10 13:15:00 2020 +0000
Fix command to filter package provider when building docs
---
BREEZE.rst | 2 +-
breeze | 2 +-
dev/README_RELEASE_AIRFLOW.md | 2 +-
dev/README_RELEASE_PROVIDER_PACKAGES.md | 12 ++++++------
4 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 1b7a2f2..7fdcbb4 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -1235,7 +1235,7 @@ This is the current syntax for `./breeze <./breeze>`_:
is generated ('docs/_build') are also mounted to the container - this way results of
the documentation build is available in the host.
- The possible extra args are: --docs-only, --spellcheck-only, --package, --help
+ The possible extra args are: --docs-only, --spellcheck-only, --package-filter, --help
####################################################################################################
diff --git a/breeze b/breeze
index 4615629..34b428c 100755
--- a/breeze
+++ b/breeze
@@ -1605,7 +1605,7 @@ ${CMDNAME} build-docs [-- <EXTRA_ARGS>]
is generated ('docs/_build') are also mounted to the container - this way results of
the documentation build is available in the host.
- The possible extra args are: --docs-only, --spellcheck-only, --package, --help
+ The possible extra args are: --docs-only, --spellcheck-only, --package-filter, --help
"
readonly DETAILED_USAGE_BUILD_DOCS
export DETAILED_USAGE_BUILD_IMAGE="
diff --git a/dev/README_RELEASE_AIRFLOW.md b/dev/README_RELEASE_AIRFLOW.md
index ddb025b..bd895e4 100644
--- a/dev/README_RELEASE_AIRFLOW.md
+++ b/dev/README_RELEASE_AIRFLOW.md
@@ -571,7 +571,7 @@ Documentation for providers can be found in the ``/docs/apache-airflow`` directo
```shell script
cd "${AIRFLOW_REPO_ROOT}"
- ./breeze build-docs -- --package apache-airflow --for-production
+ ./breeze build-docs -- --package-filter apache-airflow --for-production
```
- Now you can preview the documentation.
diff --git a/dev/README_RELEASE_PROVIDER_PACKAGES.md b/dev/README_RELEASE_PROVIDER_PACKAGES.md
index 1686b75..8ebd9ba 100644
--- a/dev/README_RELEASE_PROVIDER_PACKAGES.md
+++ b/dev/README_RELEASE_PROVIDER_PACKAGES.md
@@ -905,9 +905,9 @@ Documentation for providers can be found in the `/docs/apache-airflow-providers`
```shell script
cd "${AIRFLOW_REPO_ROOT}"
./breeze build-docs -- \
- --package apache-airflow-providers \
- --package apache-airflow-providers-apache-airflow \
- --package apache-airflow-providers-telegram \
+ --package-filter apache-airflow-providers \
+ --package-filter apache-airflow-providers-apache-airflow \
+ --package-filter apache-airflow-providers-telegram \
--for-production
```
@@ -921,9 +921,9 @@ Documentation for providers can be found in the `/docs/apache-airflow-providers`
```shell script
./docs/publish_docs.py \
- --package apache-airflow-providers \
- --package apache-airflow-providers-apache-airflow \
- --package apache-airflow-providers-telegram \
+ --package-filter apache-airflow-providers \
+ --package-filter apache-airflow-providers-apache-airflow \
+ --package-filter apache-airflow-providers-telegram \
cd "${AIRFLOW_SITE_DIRECTORY}"
```