Skip to content

Commit 8267196

Browse files
README.md: Add mention to topics.html for Doxygen documentation
Signed-off-by: Ronald Cron <[email protected]>
1 parent e943bd7 commit 8267196

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ To generate a local copy of the library documentation in HTML format, tailored t
2424
1. Make sure that [Doxygen](http://www.doxygen.nl/) is installed.
2525
1. Run `cmake -B /path/to/build_dir /path/to/mbedtls/source`
2626
1. Run `cmake --build /path/to/build_dir --target mbedtls-apidoc`
27-
1. Browse `apidoc/index.html` or `apidoc/modules.html`.
27+
1. Open one of the main generated HTML files:
28+
* `apidoc/index.html`
29+
* `apidoc/modules.html` or `apidoc/topics.html`
2830

2931
For other sources of documentation, see the [SUPPORT](SUPPORT.md) document.
3032

0 commit comments

Comments
 (0)