isabella232 / airliner

Requirements to build airliner(Tested on Ubuntu18)

libgazebo9-dev
libboost-all-dev
python3-opencv
libopencv-dev
libgstreamer-plugins-base1.0-dev
default-jre
openjdk-8-jdk
python>=3.6
gcc-multilib
g++-multilib
cmake
libdwarf-dev
libelf-dev
libsqlite3-dev
libeigen3-dev
librxtx-java

Must install the following dependencies via pip3:
PyYAML==5.3.1
six==1.15.0
wheel==0.35.1
pytest==6.1.1
sqlite_utils==2.21
cerberus==1.3.2
yamlpath==3.4.0
Jinja2==2.11.2
yamlpath

To build docs.

This is known to work with Python 3.6

1. pip3 install sphinx
2. pip3 install sphinx-rtd-theme
3. pip3 install breathe
4. pip3 install sphinxcontrib-doxylink
5. pip3 install graphviz
6. sudo apt-get install graphviz
7. From the repository base airliner directory make docs

To open up the documentation you can run this command xdg-open airliner/build/reference/default/docs/html/index.html on Ubuntu-based distros.

These were generated by a tool called breathe-apidoc which parses xml doxygen-generated files to rst files and enables us to link to structs/classes/data structures that exists on our doxygen docs with very simple syntax from rst files.