|
|
@ -28,7 +28,7 @@ available commands, and in most cases `command help` will print the usage. |
|
|
|
Since this is generated from source, errors must be reported/fixed |
|
|
|
Since this is generated from source, errors must be reported/fixed |
|
|
|
in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) repository. |
|
|
|
in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) repository. |
|
|
|
The documentation pages can be generated by running the following command from |
|
|
|
The documentation pages can be generated by running the following command from |
|
|
|
the root of the Firmware directory: |
|
|
|
the root of the PX4-Autopilot directory: |
|
|
|
``` |
|
|
|
``` |
|
|
|
make module_documentation |
|
|
|
make module_documentation |
|
|
|
``` |
|
|
|
``` |
|
|
@ -66,7 +66,7 @@ The generated files will be written to the `modules` directory. |
|
|
|
result = '' |
|
|
|
result = '' |
|
|
|
for module in module_list: |
|
|
|
for module in module_list: |
|
|
|
result += "## %s\n" % module.name() |
|
|
|
result += "## %s\n" % module.name() |
|
|
|
result += "Source: [%s](https://github.com/PX4/Firmware/tree/master/src/%s)\n\n" % (module.scope(), module.scope()) |
|
|
|
result += "Source: [%s](https://github.com/PX4/PX4-Autopilot/tree/master/src/%s)\n\n" % (module.scope(), module.scope()) |
|
|
|
doc = module.documentation() |
|
|
|
doc = module.documentation() |
|
|
|
if len(doc) > 0: |
|
|
|
if len(doc) > 0: |
|
|
|
result += "%s\n" % doc |
|
|
|
result += "%s\n" % doc |
|
|
|