diff options
| author | Yifan Hong <elsk@google.com> | 2024-03-04 17:23:04 -0800 |
|---|---|---|
| committer | Yifan Hong <elsk@google.com> | 2024-03-06 18:29:54 +0000 |
| commit | bf4e4c857547eb458b16f88b0e2fe87af1178029 (patch) | |
| tree | 874d3a91ece9d56b3c00434af98b65791fd6b971 | |
| parent | c407278e379f019c92525a1f849d96649d7de3f9 (diff) | |
| download | build-bf4e4c857547eb458b16f88b0e2fe87af1178029.tar.gz | |
kleaf: Add links to CodeSearch and Gitiles for API reference.
Due to bugs, anchor links don't quite work. But
they both provide a decent rendering.
Test: N/A
Bug: 327647132
Bug: 276493276
Change-Id: Ic0aa33c4f9a9dd0767045f0b06d8c59cf0d65bcf
| -rw-r--r-- | kleaf/docs/api_reference.md | 25 |
1 files changed, 22 insertions, 3 deletions
diff --git a/kleaf/docs/api_reference.md b/kleaf/docs/api_reference.md index 16a2ffb..7adb4f2 100644 --- a/kleaf/docs/api_reference.md +++ b/kleaf/docs/api_reference.md @@ -2,10 +2,29 @@ ## For the current branch -You may view the documentation for the aforementioned Bazel rules and macros in -[api_reference](api_reference). +You may find the documentation for the aforementioned Bazel rules and macros in +the [api_reference](api_reference) directory. -The link redirects to the generated documentation for this branch. +Use your favorite Markdown renderer to view the files locally. + +* If you are using VS Code, see + [instructions](https://code.visualstudio.com/docs/languages/markdown#_markdown-preview) + for previewing Markdown files. + +## View online + +You may also view the API reference for `android-mainline` online by using +the links below. + +**Note**: Due to known bugs in Markdown rendering, links to anchors may +or may not work. + +<!-- Ref: b/327647132 --> + +- To view the API reference on Code Search, visit + [https://cs.android.com/android/kernel/superproject/+/common-android-mainline:build/kernel/kleaf/docs/api_reference/](https://cs.android.com/android/kernel/superproject/+/common-android-mainline:build/kernel/kleaf/docs/api_reference/) +- To view the API reference on Gitiles, visit + [https://android.googlesource.com/kernel/build/+/refs/heads/main/kleaf/docs/api_reference](https://android.googlesource.com/kernel/build/+/refs/heads/main/kleaf/docs/api_reference). ## Updating docs |