Plugin: Git revision date localized plugin added (#60)

ROS-Aerial · Nov 18, 2024 · d24b1d3 · d24b1d3
1 parent d039357
commit d24b1d3
Show file tree

Hide file tree

Showing 12 changed files with 23 additions and 2 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -13,6 +13,6 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs pymdown-extensions
+      - run: pip install mkdocs pymdown-extensions mkdocs-git-revision-date-localized-plugin
       - run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
       - run: mkdocs gh-deploy --force
diff --git a/docs/aerial_autonomy_stacks.md b/docs/aerial_autonomy_stacks.md
@@ -102,4 +102,6 @@ Given the above [Aerial Autonomy Stacks](https://github.com/ROS-Aerial/aerial_ro
 | [px4_sim_ros2](https://github.com/ParsaKhaledi/px4_sim_ros2)   | ✓    | Stereo camera | ROS 2 | Gazebo | PX4 | 04/2024 |
 | [pidrone_pkg](https://github.com/h2r/pidrone_pkg/tree/dd21)   | ✓    | Mono camera/IR | ROS 1 | N/A | Duckiedrone | 05/2024 |
 
+This page was last updated: *{{ git_revision_date_localized }}*
+
 --8<-- "docs/goatcounter.html"
diff --git a/docs/aerial_vehicles.md b/docs/aerial_vehicles.md
@@ -56,4 +56,6 @@ Each autopilot suite have their a wide range of supported vehicles, to which thi
 * [PX4](https://docs.px4.io/master/en/airframes/airframe_reference.html)
 * [Crazyflie](https://www.bitcraze.io/documentation/repository/crazyflie-firmware/master/#the-crazyflie-2x-family)
 
+This page was last updated: *{{ git_revision_date_localized }}*
+
 --8<-- "docs/goatcounter.html"
diff --git a/docs/autopilots_suites.md b/docs/autopilots_suites.md
@@ -14,4 +14,6 @@ There are several autopilot suites available for control-boards for aerial vehic
 
 *community provided support
 
+This page was last updated: *{{ git_revision_date_localized }}*
+
 --8<-- "docs/goatcounter.html"
diff --git a/docs/education_and_tutorial.md b/docs/education_and_tutorial.md
@@ -108,4 +108,6 @@ _This list contains some resources that we haven't included in the overview. Rem
 
 Lots of thanks for anybody contributing to this [linkedin post](https://www.linkedin.com/feed/update/urn:li:activity:7079385991144185856/). This was extremely helpful!
 
+This page was last updated: *{{ git_revision_date_localized }}*
+
 --8<-- "docs/goatcounter.html"
diff --git a/docs/hardware.md b/docs/hardware.md
@@ -155,4 +155,6 @@ The [Holybro S500v2](https://holybro.com/collections/s500/products/s500-v2-devel
 **Useful tool for this page**:
 <https://tabletomarkdown.com/convert-spreadsheet-to-markdown/>
 
+This page was last updated: *{{ git_revision_date_localized }}*
+
 --8<-- "docs/goatcounter.html"
diff --git a/docs/index.md b/docs/index.md
@@ -55,4 +55,3 @@ More substantial changes, including adding new pages or adding/modifying images,
 4. Create a branch for your changes and create a pull request (PR) to pull it back into the documentation.
 
 --8<-- "docs/goatcounter.html"
-
diff --git a/docs/message_standards.md b/docs/message_standards.md
@@ -23,5 +23,7 @@ MAVlink is used in 2 autopilot suites. Eventhough the same message type are bein
 * [Ardupilot MAVlink usage](https://ardupilot.org/dev/docs/mavlink-basics.html)
 * [PX4 MAVlink usage](https://docs.px4.io/main/en/middleware/mavlink.html)
 
+This page was last updated: *{{ git_revision_date_localized }}*
+
 --8<-- "docs/goatcounter.html"
 
diff --git a/docs/middleware_and_drivers.md b/docs/middleware_and_drivers.md
@@ -19,4 +19,6 @@ ROS packages built atop SDKs from drone vendors to interface to their closed-sou
 3. [DJI Tello driver](https://github.com/anqixu/tello_driver)
 4. [Parrot Mambo driver](https://github.com/TOTON95/ros_pyparrot)
 
+This page was last updated: *{{ git_revision_date_localized }}*
+
 --8<-- "docs/goatcounter.html"
diff --git a/docs/safety_management.md b/docs/safety_management.md
@@ -83,4 +83,6 @@ Here a list of that:
 * Dealing with spinning motors Use a net or towel to stop them and promptly disconnect the battery.
 * To prepare for LiPo battery hazards, Have sand or fire retardant available.
 
+This page was last updated: *{{ git_revision_date_localized }}*
+
 --8<-- "docs/goatcounter.html"
diff --git a/docs/simulation.md b/docs/simulation.md
@@ -115,4 +115,6 @@ Several autopilot suites provide instructions for using simulators, often with S
 * **PX4**: <https://docs.px4.io/main/en/simulation/#simulation>
 * **ROSflight**: <https://docs.rosflight.org/v1.3/user-guide/gazebo_simulation/>
 
+This page was last updated: *{{ git_revision_date_localized }}*
+
 --8<-- "docs/goatcounter.html"
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -20,3 +20,7 @@ markdown_extensions:
 - pymdownx.snippets:
     check_paths: true
 - admonition
+
+plugins:
+    - search
+    - git-revision-date-localized
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,4 +14,6 @@ There are several autopilot suites available for control-boards for aerial vehic

		*community provided support

		This page was last updated: {{ git_revision_date_localized }}

		--8<-- "docs/goatcounter.html"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -108,4 +108,6 @@ _This list contains some resources that we haven't included in the overview. Rem

		Lots of thanks for anybody contributing to this [linkedin post](https://www.linkedin.com/feed/update/urn:li:activity:7079385991144185856/). This was extremely helpful!

		This page was last updated: {{ git_revision_date_localized }}

		--8<-- "docs/goatcounter.html"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -55,4 +55,3 @@ More substantial changes, including adding new pages or adding/modifying images,
		4. Create a branch for your changes and create a pull request (PR) to pull it back into the documentation.

		--8<-- "docs/goatcounter.html"