The Airflow documentation is located at:
- https://airflow.apache.org (latest stable)
- https://airflow.readthedocs.io/en/latest/ (latest master)
The documentation for release versions ≥ 1.9 can be accessed from the above links as well (e.g., 1.9.0 is httpsThe site for the Airflow documentaiton that used to be located at pythonhosted.org is now located at http://airflow.incubator.apache.org/readthedocs.io/en/1.9.0/).
Docs hosted on ASF
It's a static site that is sourced from `https://git-wip-us.apache.org/repos/asf/incubator-github.com/apache/airflow-site.git` on the `asf-site` branch.
Make sure to install all Airflow python dependencies by running the following before building the docs:
| Code Block | ||
|---|---|---|
| ||
pip install apache-airflow[all] |
To build the docs, run `python setup.py build_sphinx` from the main airflow project, this builds a static site under `docs/_build/html/`. You can then copy the content of this folder to root of the repo/branch mentioned above. Alternatively, you can `cd docs; ./build.sh`
The website doesn't have a `master` branch, just asf-site. You'll need to:
| Code Block | ||
|---|---|---|
| ||
git clone https://github.com/apache/airflow-site.git
git checkout asf-site |
Also create a new folder with the name of the version and copy paste all contents there as well. So that you can access it using for example https://airflow.apache.org/1.10.2/ as well as https://airflow.apache.org
Read the Docs
The Read the Docs documentation site is automatically built via a GitHub webhook.
Local
To build the docs locally, follow the instructions in Contributing > Documentation which builds a static site under docs/_build/html.
Dependencies
The list (Incomplete) List of Python packages required to build the docs :
...
can be found under the 'doc' extra in setup.py.