• Created by Unknown User (maximebeauchemin), last updated by Unknown User (kaxilnaik) on Aug 27, 2018 1 minute read

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

The Airflow documentation is located at:

The documentation for release versions ≥ 1.9 can be accessed from the above links as well (e.g., 1.9.0 is https://airflow.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-airflow-site.git` on the `asf-site` branch.

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:

git clone https://git-wip-us.apache.org/repos/asf/incubator-airflow-site.git
git checkout asf-site

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 of Python packages required to build the docs can be found under the 'doc' extra in setup.py.


  • No labels