Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use readme.md as main page for Doxygen #483

Merged
merged 1 commit into from
Nov 24, 2024
Merged

Use readme.md as main page for Doxygen #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

**Notice:** Running the AWS IoT Device Client will incur usage of AWS IoT services, and is likely to incur charges on your AWS account. Please refer the pricing pages for [AWS IoT Core](https://aws.amazon.com/iot-core/pricing/), [AWS IoT Device Management](https://aws.amazon.com/iot-device-management/pricing/), and [AWS IoT Device Defender](https://aws.amazon.com/iot-device-defender/pricing/) for more details.

*__Jump To:__*
***Jump To:***
* [Introduction](#introduction)
* [Installation](#installation)
* [Setup & Configuration](#setup-and-configuration)
Expand All @@ -26,7 +26,7 @@
* [License](#license)

## Introduction
*__Sections:__*
***Sections:***
* [Current Capabilities](#current-capabilities)
* [List of Supported Platforms](#list-of-supported-platforms)

Expand Down Expand Up @@ -56,7 +56,7 @@ The modular IoT Device Client consists of a “base client” and discrete “cl
The AWS IoT Device Client is currently compatible with x86_64, aarch64, armv7l, mips32, ppc64, and ppc64le architectures and common Linux software environments (Debian, Ubuntu, and RHEL).

## Installation
*__Sections:__*
***Sections:***
+ [Minimum Requirements](#minimum-requirements)
+ [Building from source](#building-from-source)
+ [Running the tests](#running-the-tests)
Expand Down
4 changes: 2 additions & 2 deletions docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,7 +844,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ../source/
INPUT = ../README.md ../source/

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -1041,7 +1041,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = ../README.md

#---------------------------------------------------------------------------
# Configuration options related to source browsing
Expand Down
Loading