From 674ae5292ee420a45c769cc9ac0cb0fe0da78334 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Beat=20K=C3=BCng?= <beat-kueng@gmx.net>
Date: Mon, 8 May 2017 09:44:53 +0200
Subject: [PATCH] markdown module doc script: write how to generate the modules
 documentation

---
 .gitignore                        | 2 ++
 Tools/px4moduledoc/markdownout.py | 6 ++++++
 2 files changed, 8 insertions(+)

diff --git a/.gitignore b/.gitignore
index a323c58cc3..4c35c53cbb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -77,8 +77,10 @@ posix-configs/SITL/init/test/*_generated
 parameters.md
 airframes.md
 airframes.xml
+/modules
 
 cppcheck-result.xml
 cppcheck
 
 scan-build
+
diff --git a/Tools/px4moduledoc/markdownout.py b/Tools/px4moduledoc/markdownout.py
index 1efe806f08..735489dd2d 100644
--- a/Tools/px4moduledoc/markdownout.py
+++ b/Tools/px4moduledoc/markdownout.py
@@ -22,6 +22,12 @@ available commands, and in most cases `command help` will print the usage.
 
 Since this is generated from source, errors must be reported/fixed
 in the [Firmware](https://github.com/PX4/Firmware) repository.
+The documentation pages can be generated by running the following command from
+the root of the Firmware directory:
+```
+make module_documentation
+```
+The generated files will be written to the `modules` directory.
 
 ## Categories
 """