diff options
| author | Chad Norvell <chadnorvell@google.com> | 2023-05-05 07:10:20 +0000 |
|---|---|---|
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2023-05-05 07:10:20 +0000 |
| commit | f92c5604b6d0b5610ea11a4c6a026739b78299d1 (patch) | |
| tree | 113dea37b5fc0004bb70ee5a61232cd396700aa7 /pw_string | |
| parent | 513be82354c43849c834bd91f29e0d04306cec7d (diff) | |
| download | pigweed-f92c5604b6d0b5610ea11a4c6a026739b78299d1.tar.gz | |
pw_docgen: Refactor metadata extension
- Allow custom nav buttons
- Show nav on all module doc subpages
Bug: 280593975
Change-Id: I6afc1b37d2e6907cbbeb6bc80b6d0d997f67c919
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/144890
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Kayce Basques <kayce@google.com>
Commit-Queue: Chad Norvell <chadnorvell@google.com>
Diffstat (limited to 'pw_string')
| -rw-r--r-- | pw_string/api.rst | 8 | ||||
| -rw-r--r-- | pw_string/design.rst | 9 | ||||
| -rw-r--r-- | pw_string/docs.rst | 10 | ||||
| -rw-r--r-- | pw_string/guide.rst | 8 |
4 files changed, 30 insertions, 5 deletions
diff --git a/pw_string/api.rst b/pw_string/api.rst index 55cd7264c..f13ca3354 100644 --- a/pw_string/api.rst +++ b/pw_string/api.rst @@ -3,6 +3,14 @@ ============= API Reference ============= +.. pigweed-module-subpage:: + :name: pw_string + :tagline: Efficient, easy, and safe string manipulation + :nav: + getting started: module-pw_string-get-started + design: module-pw_string-design + guides: module-pw_string-guide + api: module-pw_string-api -------- Overview diff --git a/pw_string/design.rst b/pw_string/design.rst index 91202e185..e072a552a 100644 --- a/pw_string/design.rst +++ b/pw_string/design.rst @@ -3,6 +3,15 @@ ================ pw_string design ================ +.. pigweed-module-subpage:: + :name: pw_string + :tagline: Efficient, easy, and safe string manipulation + :nav: + getting started: module-pw_string-get-started + design: module-pw_string-design + guides: module-pw_string-guide + api: module-pw_string-api + ``pw_string`` provides string classes and utility functions designed to prioritize safety and static allocation. The APIs are broadly similar to those of the string classes in the C++ standard library, so familiarity with those diff --git a/pw_string/docs.rst b/pw_string/docs.rst index e7b46608d..8453f4edf 100644 --- a/pw_string/docs.rst +++ b/pw_string/docs.rst @@ -5,17 +5,17 @@ ========= pw_string ========= - .. pigweed-module:: :name: pw_string :tagline: Efficient, easy, and safe string manipulation :status: stable :languages: C++14, C++17 :code-size-impact: 500 to 1500 bytes - :get-started: module-pw_string-get-started - :design: module-pw_string-design - :guides: module-pw_string-guide - :api: module-pw_string-api + :nav: + getting started: module-pw_string-get-started + design: module-pw_string-design + guides: module-pw_string-guide + api: module-pw_string-api - **Efficient**: No memory allocation, no pointer indirection. - **Easy**: Use the string API you already know. diff --git a/pw_string/guide.rst b/pw_string/guide.rst index 87ceec03e..7e3d93c62 100644 --- a/pw_string/guide.rst +++ b/pw_string/guide.rst @@ -3,6 +3,14 @@ ================ pw_string: Guide ================ +.. pigweed-module-subpage:: + :name: pw_string + :tagline: Efficient, easy, and safe string manipulation + :nav: + getting started: module-pw_string-get-started + design: module-pw_string-design + guides: module-pw_string-guide + api: module-pw_string-api InlineString and StringBuilder? =============================== |