Repository: incubator-airflow Updated Branches: refs/heads/master 06b62c42b -> 702e62411
[AIRFLOW-2501] Refer to devel instructions in docs contrib guide Without the devel extra, the docs do not build. The build fails due to missing the mock package. Closes #3395 from tswast/airflow-2501-docs- contributing Project: http://git-wip-us.apache.org/repos/asf/incubator-airflow/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-airflow/commit/702e6241 Tree: http://git-wip-us.apache.org/repos/asf/incubator-airflow/tree/702e6241 Diff: http://git-wip-us.apache.org/repos/asf/incubator-airflow/diff/702e6241 Branch: refs/heads/master Commit: 702e62411b9b095fc6c28d78ccff7acc0853c00c Parents: 06b62c4 Author: Tim Swast <[email protected]> Authored: Mon May 21 20:58:00 2018 +0100 Committer: Kaxil Naik <[email protected]> Committed: Mon May 21 20:58:00 2018 +0100 ---------------------------------------------------------------------- CONTRIBUTING.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/702e6241/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73c0a13..416a14e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,12 +63,20 @@ If you are proposing a feature: ## Documentation -The latest API documentation is usually available [here](https://airflow.incubator.apache.org/). -To generate a local version, you need to have installed airflow with -the `doc` extra. In that case you can generate the doc by running: +The latest API documentation is usually available +[here](https://airflow.incubator.apache.org/). To generate a local version, +you need to have set up an Airflow development environemnt (see below). Also +install the `doc` extra. + + pip install -e .[doc] + +Generate the documentation by running: cd docs && ./build.sh +Only a subset of the API reference documentation builds. Install additional +extras to build the full API reference. + ## Development and Testing ### Setting up a development environment
