mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-11-22 14:19:57 +08:00
docs(modules): add auto-generated disclaimer to every module reference page (#29673)
Only modules_main.md told readers that the module reference is generated from source. The per-category pages (modules_driver.md, modules_system.md, ...) and the per-subcategory pages (modules_driver_imu.md, ...) had no such note, so contributors kept fixing typos directly in docs/en/modules/ and the next metadata sync silently reverted them (see #29614). Emit a `::: info` block right under the H1 of every category and subcategory page. The wording follows the existing disclaimers on the airframe reference and the uORB message index: it links to the generator script and names the `make module_documentation` target. docs/en/modules/*.md are regenerated with the updated generator and run through Prettier, mirroring what the docs-orchestrator metadata sync does on main, so the diff is only the new note. Fixes #29624 Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Alex E <aelejandro9@gmail.com>
This commit is contained in:
1 parent
ca7b6d9819
commit
59fa7a4a7d
22 files changed
+117
-1
No files matched your search
@@ -7,6 +7,15 @@ from xml.sax.saxutils import escape
|
||||
import codecs
|
||||
import os
|
||||
|
||||
# Shown at the top of every category/subcategory page so readers know these
|
||||
# files are generated and must be fixed in the module source, not in docs/.
|
||||
AUTOGEN_NOTE = """
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
"""
|
||||
|
||||
class MarkdownOutput():
|
||||
def __init__(self, module_groups):
|
||||
|
||||
@@ -45,7 +54,8 @@ The generated files will be written to the `modules` directory.
|
||||
self._outputs['main'] = result
|
||||
|
||||
for category in sorted(module_groups):
|
||||
result = f"# Modules Reference: {category.capitalize()}\n\n"
|
||||
result = f"# Modules Reference: {category.capitalize()}\n"
|
||||
result += AUTOGEN_NOTE + '\n'
|
||||
subcategories = module_groups[category]
|
||||
|
||||
if len(subcategories) > 1:
|
||||
@@ -59,6 +69,7 @@ The generated files will be written to the `modules` directory.
|
||||
|
||||
# add a sub-page for the subcategory
|
||||
result_subpage = f'# Modules Reference: {subcategory_label} ({category.capitalize()})\n'
|
||||
result_subpage += AUTOGEN_NOTE
|
||||
result_subpage += self._ProcessModules(subcategories[subcategory])
|
||||
self._outputs[subcategory_file_name] = result_subpage
|
||||
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Autotune
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## fw_autotune_attitude_control
|
||||
|
||||
Source: [modules/fw_autotune_attitude_control](https://github.com/PX4/PX4-Autopilot/tree/main/src/modules/fw_autotune_attitude_control)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Command
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## actuator_test
|
||||
|
||||
Source: [systemcmds/actuator_test](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/actuator_test)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Communication
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## frsky_telemetry
|
||||
|
||||
Source: [drivers/telemetry/frsky_telemetry](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/telemetry/frsky_telemetry)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Controller
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## airship_att_control
|
||||
|
||||
Source: [modules/airship_att_control](https://github.com/PX4/PX4-Autopilot/tree/main/src/modules/airship_att_control)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Driver
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
Subcategories:
|
||||
|
||||
- [Adc](modules_driver_adc.md)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Adc (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## ADS7128
|
||||
|
||||
Source: [drivers/adc/ads7128](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/adc/ads7128)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Airspeed Sensor (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## asp5033
|
||||
|
||||
Source: [drivers/differential_pressure/asp5033](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/differential_pressure/asp5033)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Baro (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## bmp280
|
||||
|
||||
Source: [drivers/barometer/bmp280](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/barometer/bmp280)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Camera (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## camera_trigger
|
||||
|
||||
Source: [drivers/camera_trigger](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/camera_trigger)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Distance Sensor (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## afbrs50
|
||||
|
||||
Source: [drivers/distance_sensor/broadcom/afbrs50](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/broadcom/afbrs50)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Imu (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## adis16448
|
||||
|
||||
Source: [drivers/imu/analog_devices/adis16448](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/imu/analog_devices/adis16448)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Ins (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## MicroStrain
|
||||
|
||||
Source: [drivers/ins/microstrain](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/ins/microstrain)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Magnetometer (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## af9838
|
||||
|
||||
Source: [drivers/magnetometer/voltafield/af9838](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/magnetometer/voltafield/af9838)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Optical Flow (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## thoneflow
|
||||
|
||||
Source: [drivers/optical_flow/thoneflow](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/optical_flow/thoneflow)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Radio Control (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## crsf_rc
|
||||
|
||||
Source: [drivers/rc/crsf_rc](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/rc/crsf_rc)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Rpm Sensor (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## pcf8583
|
||||
|
||||
Source: [drivers/rpm/pcf8583](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/rpm/pcf8583)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Transponder (Driver)
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## sagetech_mxs
|
||||
|
||||
Source: [drivers/transponder/sagetech_mxs](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/transponder/sagetech_mxs)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Estimator
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## AttitudeEstimatorQ
|
||||
|
||||
Source: [modules/attitude_estimator_q](https://github.com/PX4/PX4-Autopilot/tree/main/src/modules/attitude_estimator_q)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Simulation
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## simulator_sih
|
||||
|
||||
Source: [modules/simulation/simulator_sih](https://github.com/PX4/PX4-Autopilot/tree/main/src/modules/simulation/simulator_sih)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: System
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## battery_simulator
|
||||
|
||||
Source: [modules/simulation/battery_simulator](https://github.com/PX4/PX4-Autopilot/tree/main/src/modules/simulation/battery_simulator)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Modules Reference: Template
|
||||
|
||||
::: info
|
||||
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
||||
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
||||
:::
|
||||
|
||||
## mc_raptor
|
||||
|
||||
Source: [modules/mc_raptor](https://github.com/PX4/PX4-Autopilot/tree/main/src/modules/mc_raptor)
|
||||
|
||||
Reference in new issue
Block a user