From e7322e88a8078aca7efacc6ce8486ba6fc20b9b9 Mon Sep 17 00:00:00 2001 From: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com> Date: Mon, 5 Aug 2024 22:35:09 +0530 Subject: [PATCH] Update the mqtt.tag file location (#303) Description ----------- The `mqtt.tag` was generated at `coreMQTT/docs/doxygen/output/mqtt.tag`. The [doxygen-generation](https://github.com/FreeRTOS/CI-CD-Github-Actions/tree/main/doxygen-generation) GH action deploys the content of `coreMQTT/docs/doxygen/output/html` and as a result, the `mqtt.tag` was not getting deployed. This change updates the location of `mqtt.tag` to `coreMQTT/docs/doxygen/output/html/mqtt.tag` to ensure that it gets deployed by the doxygen-generation GH action. Test Steps ----------- Generated the doxygen documentation locally. Checklist: ---------- - [x] I have tested my changes. No regression in existing tests. - [NA] I have modified and/or added unit-tests to cover the code changes in this Pull Request. Related Issue ----------- NA. By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. --------- Signed-off-by: Gaurav Aggarwal --- README.md | 2 +- docs/doxygen/config.doxyfile | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 48c68ae9..c59471ab 100644 --- a/README.md +++ b/README.md @@ -216,7 +216,7 @@ locations below: | Location | | :------------------------------------------------------------------------------------------------------------------: | | [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) | -| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/coreMQTT/docs/doxygen/output/html/index.html) | +| [API Reference](https://freertos.github.io/coreMQTT/main/index.html) | Note that the latest included version of coreMQTT may differ across repositories. diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile index 40634095..ca0047ec 100644 --- a/docs/doxygen/config.doxyfile +++ b/docs/doxygen/config.doxyfile @@ -2339,7 +2339,7 @@ TAGFILES = # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = docs/doxygen/output/mqtt.tag +GENERATE_TAGFILE = docs/doxygen/output/html/mqtt.tag # If the ALLEXTERNALS tag is set to YES, all external class will be listed in # the class index. If set to NO, only the inherited external classes will be