Skip to content

Commit

Permalink
update README_RELEASE_PROVIDER_PACKAGES.md (#28682)
Browse files Browse the repository at this point in the history
  • Loading branch information
eladkal authored Jan 2, 2023
1 parent 5246c00 commit 322dd3f
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion dev/README_RELEASE_PROVIDER_PACKAGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,11 +380,24 @@ You will need to change it manually to see the docs
**NOTE** In order to run the publish documentation you need to activate virtualenv where you installed
apache-airflow with doc extra:

* `pip install apache-airflow[doc]`
* `pip install 'apache-airflow[doc_gen]'`

If you don't have virtual env set you can do:

```shell script
cd <path_you_want_to_save_your_virtual_env>
virtualenv providers

source venv/providers/bin/activate

pip install 'apache-airflow[doc_gen]'
```

All providers (including overriding documentation for doc-only changes):

```shell script
cd "${AIRFLOW_REPO_ROOT}"

./docs/publish_docs.py \
--package-filter apache-airflow-providers \
--package-filter 'apache-airflow-providers-*' \
Expand All @@ -396,6 +409,8 @@ cd "${AIRFLOW_SITE_DIRECTORY}"
If you have providers as list of provider ids because you just released them you can build them with

```shell script
cd "${AIRFLOW_REPO_ROOT}"

./dev/provider_packages/publish_provider_documentation.sh amazon apache.beam google ....
```

Expand Down

0 comments on commit 322dd3f

Please sign in to comment.