From 6796945d0b73ec9bed29adbbc1ee3fa385a4c37f Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Wed, 17 Apr 2024 11:28:07 +1000 Subject: [PATCH] Fix up notes boxes for docs (#22999) * Fix up notes boxes for docs * Update markdownout.py * Update markdownout.py * Update markdownout.py --- Tools/msg/generate_msg_docs.py | 2 +- Tools/px4airframes/markdownout.py | 2 +- Tools/px4moduledoc/markdownout.py | 2 +- src/lib/parameters/px4params/markdownout.py | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Tools/msg/generate_msg_docs.py b/Tools/msg/generate_msg_docs.py index 620646f2fd..a44a317b52 100755 --- a/Tools/msg/generate_msg_docs.py +++ b/Tools/msg/generate_msg_docs.py @@ -89,7 +89,7 @@ if __name__ == "__main__": # Write out the index.md file index_text="""# uORB Message Reference -:::note +::: info This list is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/msg/generate_msg_docs.py) from the source code. ::: diff --git a/Tools/px4airframes/markdownout.py b/Tools/px4airframes/markdownout.py index e6b69ce31a..bf1a605723 100644 --- a/Tools/px4airframes/markdownout.py +++ b/Tools/px4airframes/markdownout.py @@ -7,7 +7,7 @@ class MarkdownTablesOutput(): def __init__(self, groups, board, image_path): result = """# Airframes Reference -:::note +::: info **This list is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4airframes/markdownout.py) from the source code** using the build command: `make airframe_metadata`. ::: diff --git a/Tools/px4moduledoc/markdownout.py b/Tools/px4moduledoc/markdownout.py index 290618446e..469e031a63 100644 --- a/Tools/px4moduledoc/markdownout.py +++ b/Tools/px4moduledoc/markdownout.py @@ -19,7 +19,7 @@ The following pages document the PX4 modules, drivers and commands. They describe the provided functionality, high-level implementation overview and how to use the command-line interface. -:::note +::: info **This is auto-generated from the source code** and contains the most recent modules documentation. ::: diff --git a/src/lib/parameters/px4params/markdownout.py b/src/lib/parameters/px4params/markdownout.py index cd4f5e921c..f83c504f80 100644 --- a/src/lib/parameters/px4params/markdownout.py +++ b/src/lib/parameters/px4params/markdownout.py @@ -7,11 +7,11 @@ class MarkdownTablesOutput(): result = ( """# Parameter Reference -:::note +::: info This documentation was auto-generated from the source code for this PX4 version (using `make parameters_metadata`). ::: -:::tip +::: tip If a listed parameter is missing from the Firmware see: [Finding/Updating Parameters](../advanced_config/parameters.md#parameter-not-in-firmware). :::