From 431536762da7e5155474da6a52823463a0e91226 Mon Sep 17 00:00:00 2001 From: Alexander Pacha Date: Mon, 3 Apr 2017 17:51:05 +0200 Subject: [PATCH] Using Sphinx RTD Theme instead of alabaster, because it is more beautiful. Made h2-titles into h1 titles --- docs/conf.py | 6 +++++- docs/index.rst | 11 ++++++----- docs/requirements.txt | 1 + 3 files changed, 12 insertions(+), 6 deletions(-) create mode 100644 docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 0c2bf58..0882e35 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,7 +85,11 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" + +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/index.rst b/docs/index.rst index 3db83ab..25f7423 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,23 +21,24 @@ Apart from these two sensors, the following sensors are available for comparison This application was developed for demonstrating the sensor fusion approach developed for my `Master Thesis "Sensor fusion for robust outdoor Augmented Reality tracking on mobile devices `_ at the `Human Interface Technology Laboratory New Zealand `_. -A short summary can also be found in this `Stackoverflow answer `_. Euler Angles ------------- +============ Euler-Angles are also often referred to as Azimuth, Pitch and Roll and describe the rotation of an object in the three-dimensional space with respect to three axis that are simple to understand and visualize. However, they have certain limitations and have therefore been removed from this project. If you want to obtain the rotation using Euler-Angles, check out `the last tag that contained the Euler angles `_. Notice that they have been removed, because many people don't understand Euler Angles fully and are surprised, when they get results, that they did not expect (because the representation is ambiguous and suffers from Gimbal Lock). Try to use a Rotation Matrix, a Rotation Vector or Quaternions instead. +A short summary can also be found in this `Stackoverflow answer `_. + Installation ------------- +============ This project is an Gradle-based Android Studio project. It is also published in the `Google Play Store `_, if you just want to try it out. Contribute ----------- +========== - `Issue Tracker `_ - `Source Code `_ @@ -49,7 +50,7 @@ Contribute 5. Create new Pull Request License -------- +======= Released under the MIT license. diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..52b04f2 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx_rtd_theme \ No newline at end of file