OpenSky API Documentation

We are using Sphinx.

The latest compiled version of this documentation is accessible here

Build¹

If you need to build the docs, follow these steps:

1. Install Sphinx with your package manager or any other method described here.

   apt-get install python-sphinx

2. Install the Read the Docs Theme

   pip install sphinx_rtd_theme

3. Create the Sphinx documentation and Javadoc²

   make

The results can be found in free/_build/html.

[1]: Package installation examples for Ubuntu [2]: If you don't have make or maven: apt-get install build-essential maven