Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add Read the Docs versions, updated build instructions, removed no longer relevant parts

 

The site for the Airflow documentation that used to be is located at pythonhosted.org is now located at http:

...

...

This should point to latest stable, while readthedocs.org keeps track of versioned documentation.

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/).

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

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`

 

(Incomplete) List of Python packages required to build the docs :

  • future
  • dill
  • mock
  • Sphinx-PyPI-upload

The website doesn't have a `master` branch, just asf-site. You'll need to:

...

can be found under the 'doc' extra in setup.py.