Merge branch 'trunk' into alloca_fix

7 files changed, 53 insertions, 21 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
index fbed5ca00..5d53978fc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,7 +14,7 @@ Navit follows the semantic versioning:
   replacement for the previous version (all data formats and interfaces are still
   supported); minor UI changes (such as moving individual menu items) are also
   allowed
-* X.y.z (major): at least one of the following:
+* `X.y.z` (major): at least one of the following:
   * Major new functionality (such as Augmented Reality, inertial navigation or
     support for live traffic services): de-facto standard for end-user apps
   * New user interface (such as moving from the old pulldown menu UI to the Internal
@@ -85,14 +85,14 @@ To get the list of all the unreleased commits, see:
 
 Release 0.5.2 had issues with the version not properly updated in the `CMakeLists.txt`. This release fixes that issue.
 
-## Changed
+### Changed
 
 * Update Sailfish spec for release 0.5.3. [Joseph Herlant]
 * Update Patch version for release 0.5.3. [Joseph Herlant]
 
 ## [v0.5.2] - 2018-08-30
 
-## Added
+### Added
 
 * Add:build:Make gradlew executable. [mvglasow]
 * Add:build:Ignore gradle artifacts. [mvglasow]
@@ -102,7 +102,7 @@ Release 0.5.2 had issues with the version not properly updated in the `CMakeList
 * Add:build:Add cmake4eclipse artifacts to .gitignore (#594) [mvglasow]
 * Add Slovakia and Belgium to the maplist. [jandegr]
 
-## Changed
+### Changed
 
 * Update:doc:Update AUTHORS file. [Joseph Herlant]
 * Update in-tree espeak to espeak-1.48.04 (#624) [Stefan Wildemann]
@@ -133,7 +133,7 @@ Release 0.5.2 had issues with the version not properly updated in the `CMakeList
 * Refactor:core:Improve documentation of route\_value\_seg() [mvglasow]
 * Update:release:Add more keywords for gitchangelog
 
-## Fixed
+### Fixed
 
 * Fix Android apk VersionCode  (#633) [jkoan]
 * Fix latlon2bookmark (#627) [jkoan]
@@ -177,7 +177,7 @@ Release 0.5.2 had issues with the version not properly updated in the `CMakeList
 * Refactor:Android (#563) [jandegr]
 * Refactoring:Android:cleanup (#458) [jandegr]
 
-## Removed
+### Removed
 
 * Cleanup:osd&support\_espeak:get rid of unused-variables compilation warnings (#619) [Joseph Herlant]
 * Cleanup:scripts:removes deprecated usage of egrep (#616) [Joseph Herlant]
@@ -192,7 +192,7 @@ Release 0.5.2 had issues with the version not properly updated in the `CMakeList
 
 ## [v0.5.1] - 2018-04-19
 
-## Added
+### Added
 
 * Adding question mark to icon for position pending (#423) [lains]
 * Add:icon:forbiden\_area (#331) [youte62]
@@ -275,7 +275,7 @@ Release 0.5.2 had issues with the version not properly updated in the `CMakeList
 * Add:port\_android:OSD button and command to show Android menu. [mvglasow]
 * Adding a androix/x86 build script. [Pierre GRANDIN]
 
-## Changed
+### Changed
 
 * Update NavitVehicle.java. [jandegr]
 * Update NavitVehicle.java. [jandegr]
@@ -446,7 +446,7 @@ Release 0.5.2 had issues with the version not properly updated in the `CMakeList
 * Update build\_android\_x86.sh. [jandegr]
 * Updated COPYRIGHT for 2016. [Pierre GRANDIN]
 
-## Fixed
+### Fixed
 
 * Contrib:New version for sailfish 0.5.1-r5 (#444) [Stefan Wildemann]
 * OSD:Make Image and Scale osd types obey osd\_configuration setting (trac:1202) (#439) [Robert Pohlink]
@@ -578,14 +578,14 @@ Release 0.5.2 had issues with the version not properly updated in the `CMakeList
 * Osd: Make osd "Button" accept h and w props. [Stefan Wildemann]
 * Core:Crash in country\_search\_new Properly handle coutry search by attr\_country\_id to fix crash in internal gui when there's a gps fix and a map supporting attr\_country\_id such as Reiseplaner is active. Fixes #1337. [Michael Dankov]
 
-## Removed
+### Removed
 
 * Removed deprecated files and fixed a configuration example. [jkoan]
 * Cleanup old xpm icons (#292) [Johan Fitié]
 * Removed autotools lefotover (#204) [jandegr]
 * Cleanup. [jandegr]
 
-## Other
+### Other
 
 * Show min/max elevation and distance in height profile. [Timo]
 * Maptool: migrate strdup to g\_strdup. [Joseph Herlant]
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4a71f995c..5ea95ad43 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,8 +3,8 @@
 Welcome to Navit! We welcome contributions!
 
 If you are interested in contributing to the [Navit code repo](README.md)
-then checkout the [Wiki](https://wiki.navit-project.org/index.php/Main_Page)
-and our [ReadTheDocs space](https://navit.readthedocs.io)
+then checkout the [old Wiki](https://wiki.navit-project.org/index.php/Main_Page)
+and our [new wiki hosted on ReadTheDocs](https://navit.readthedocs.io)
 
 When pushing a pull request, please make sure you follow our:
 * [programming guidelines](https://navit.readthedocs.io/en/trunk/development/programming_guidelines.html)
@@ -55,6 +55,30 @@ If your changes are more complex, catch up new ideas, or still have some minor p
 
 So that's it, you helped Navit to go one step forward. Thank you very much :)
 
+## Contributing on the documentation
+
+For the documentation we now use [readthedocs](https://navit.readthedocs.io/en/trunk/) pulled from the docs folder inside this repository<.
+
+We follow the [Documentation style guide from Sphinx](https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html) (as readthedocs uses sphinx).
+With a small exception which is that we still use the `.rst` extension instead of the recommended `.txt` one for now.
+
+The [old wiki](https://wiki.navit-project.org/index.php) has been deprecated and is slowly being migrated to our
+[new wiki](https://navit.readthedocs.io/en/trunk/).
+
+To update or add documentation, create a pull request on github using a PR title starting by `update:doc:` and followed by a
+message explaining the change.
+
+You can use the following command from the root of the git repository clone to check the linting of the documentation (The last argument is the output directory so you might have to adjust that) if you have `sphinx-build` installed:
+
+```
+mkdir /tmp/navit
+sphinx-build -Dhtml_theme="sphinx_rtd_theme" -n -E -W --keep-going docs /tmp/navit/
+```
+
+Now if you want to view how the result would look like you can:
+ * open <file:///tmp/navit/index.html> in your favorite browser
+ * or if you prefer to run an http server on the directory you created the build in (`/tmp/navit/` in the previously mentionned command) you can do so using: `python3 -m http.server 8000` and then call <http://localhost:8000> from your browser.
+
 ## See also
 
  * [programming guidelines](https://navit.readthedocs.io/en/trunk/development/programming_guidelines.html)
diff --git a/docs/conf.py b/docs/conf.py
index a8b73e774..99af94fe4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,6 +1,11 @@
 # -*- coding: utf-8 -*-
 from datetime import datetime
 
+extensions = [
+    'm2r',
+    'sphinx_rtd_theme',
+]
+
 source_suffix = '.rst'
 
 master_doc = 'index'
diff --git a/docs/development/changelog_wrapper.rst b/docs/development/changelog_wrapper.rst
new file mode 100644
index 000000000..071c46823
--- /dev/null
+++ b/docs/development/changelog_wrapper.rst
@@ -0,0 +1 @@
+.. mdinclude :: ../../CHANGELOG.md
diff --git a/docs/index.rst b/docs/index.rst
index 9a5600a46..80d7260a2 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -22,15 +22,15 @@ Navit is highly customizable, from map layouts and on-screen display to the deta
 .. image:: navit.png
 
 .. toctree::
-    :hidden:
-    :glob:
-    :numbered:
-    :maxdepth: 2
-    :caption: Navit's user manual
+   :hidden:
+   :glob:
+   :numbered:
+   :maxdepth: 2
+   :caption: Navit's user manual
 
-    basic_configuration
-    maps
-    configuration/index
+   basic_configuration
+   maps
+   configuration/index
 
 
 .. Indices and tables
@@ -47,6 +47,7 @@ Navit is highly customizable, from map layouts and on-screen display to the deta
    :glob:
    :caption: Navit's developer documentation
 
+   development/changelog_wrapper
    development/programming_guidelines
    development/commit_guidelines
    development/linux_development
diff --git a/docs/navit.png b/docs/navit.png
index 242aed8e4..81f3239d6 100644
--- a/docs/navit.png
+++ b/docs/navit.png
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 000000000..142a838f8
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1 @@
+m2r