Go to file
Kayce Basques a40cea068a pw_docgen: Single-source the module metadata
This change reduces boilerplate in module docs, ensures that metadata
is consistent across all of a module's docs pages, and paves the way
for improvements to //docs/modules.rst.

Bug: 292582625
Change-Id: Ib38ac37d553e9d4baa2796e1b0c53e9f619703fe
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/193333
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Commit-Queue: Kayce Basques <kayce@google.com>
Reviewed-by: Chad Norvell <chadnorvell@google.com>
2024-03-14 23:01:57 +00:00
.allstar
.vscode
build_overrides
docker
docs pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
kudzu
pw_alignment pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_allocator pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_analog
pw_android_toolchain
pw_arduino_build
pw_assert pw_assert: Introduce :backend, :backend_impl 2024-03-14 20:15:58 +00:00
pw_assert_basic pw_assert: Introduce :backend, :backend_impl 2024-03-14 20:15:58 +00:00
pw_assert_log
pw_assert_tokenized pw_assert: Introduce :backend, :backend_impl 2024-03-14 20:15:58 +00:00
pw_assert_zephyr
pw_async bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
pw_async_basic
pw_async2 pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_async2_basic
pw_base64
pw_bloat
pw_blob_store
pw_bluetooth
pw_bluetooth_hci
pw_bluetooth_profiles
pw_bluetooth_sapphire pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_boot pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_boot_cortex_m
pw_build pw_assert: Introduce :backend, :backend_impl 2024-03-14 20:15:58 +00:00
pw_build_android pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_build_info
pw_build_mcuxpresso
pw_bytes
pw_channel pw_channel: Support datagram-to-byte conversions 2024-03-13 03:54:56 +00:00
pw_checksum pw_checksum: Add missing #include <array> 2024-03-14 18:16:15 +00:00
pw_chre
pw_chrono bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
pw_chrono_embos
pw_chrono_freertos
pw_chrono_rp2040
pw_chrono_stl
pw_chrono_threadx
pw_chrono_zephyr
pw_cli
pw_compilation_testing
pw_config_loader
pw_console pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_containers
pw_cpu_exception bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_cpu_exception_cortex_m
pw_crypto bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
pw_digital_io
pw_digital_io_linux pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_digital_io_mcuxpresso
pw_digital_io_rp2040
pw_docgen pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_doctor
pw_emu pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_env_setup pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_env_setup_zephyr pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_file
pw_format pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_function pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_fuzzer pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_grpc pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_hdlc pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_hex_dump
pw_i2c
pw_i2c_linux
pw_i2c_mcuxpresso
pw_ide
pw_interrupt bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
pw_interrupt_cortex_m
pw_interrupt_xtensa
pw_interrupt_zephyr
pw_intrusive_ptr
pw_json pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_kvs pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_libc pw_libc: Define LIBC_FAST_MATH for the faster integral fixed point sqrt 2024-03-13 22:15:23 +00:00
pw_libcxx
pw_log pw_log: Introduce localized backend label flags 2024-03-14 20:50:48 +00:00
pw_log_android
pw_log_basic bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_log_null bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_log_rpc
pw_log_string pw_log: Introduce localized backend label flags 2024-03-14 20:50:48 +00:00
pw_log_tokenized pw_log: Introduce localized backend label flags 2024-03-14 20:50:48 +00:00
pw_log_zephyr
pw_malloc pw_{malloc, sys_io}: Add backend label flags 2024-03-14 21:30:26 +00:00
pw_malloc_freelist
pw_malloc_freertos
pw_metric
pw_minimal_cpp_stdlib
pw_module
pw_multibuf pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_multisink
pw_package
pw_perf_test pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_persistent_ram
pw_polyfill pw_polyfill: Update __cplusplus macro for C++23; support C 2024-03-13 06:31:37 +00:00
pw_preprocessor
pw_presubmit
pw_protobuf
pw_protobuf_compiler
pw_random
pw_result pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_ring_buffer
pw_router
pw_rpc bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
pw_rpc_transport
pw_rust pw_format: Add initial support for untyped specifiers 2024-03-14 00:27:42 +00:00
pw_snapshot
pw_software_update pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_span pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_spi
pw_spi_mcuxpresso
pw_spi_rp2040
pw_status pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_stm32cube_build
pw_stream bazel: Treat Rust warnings as errors 2024-03-14 21:52:37 +00:00
pw_stream_shmem_mcuxpresso
pw_stream_uart_linux
pw_stream_uart_mcuxpresso
pw_string pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_symbolizer
pw_sync bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
pw_sync_baremetal
pw_sync_embos
pw_sync_freertos
pw_sync_stl
pw_sync_threadx
pw_sync_zephyr
pw_sys_io pw_{malloc, sys_io}: Add backend label flags 2024-03-14 21:30:26 +00:00
pw_sys_io_ambiq_sdk bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_sys_io_arduino bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_sys_io_baremetal_lm3s6965evb bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_sys_io_baremetal_stm32f429 bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_sys_io_emcraft_sf2 bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_sys_io_mcuxpresso bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_sys_io_rp2040 bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_sys_io_stdio bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_sys_io_stm32cube bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_sys_io_zephyr
pw_system bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
pw_target_runner
pw_thread bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
pw_thread_embos
pw_thread_freertos bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_thread_stl bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_thread_threadx
pw_thread_zephyr
pw_tls_client bazel: Use pw_facade 2024-03-12 23:45:36 +00:00
pw_tls_client_boringssl
pw_tls_client_mbedtls
pw_tokenizer pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_toolchain bazel: Treat Rust warnings as errors 2024-03-14 21:52:37 +00:00
pw_toolchain_bazel pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_trace bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
pw_trace_tokenized
pw_transfer
pw_unit_test pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_unit_test_zephyr
pw_varint
pw_watch pw_docgen: Single-source the module metadata 2024-03-14 23:01:57 +00:00
pw_web
pw_work_queue
seed
targets bazel: Localize backend label flags 2024-03-13 22:16:40 +00:00
third_party
ts
zephyr
.bazelignore
.bazelrc pw_log: Introduce localized backend label flags 2024-03-14 20:50:48 +00:00
.black.toml
.clang-format
.clang-tidy
.dockerignore
.eslintrc.cjs
.git-blame-ignore-revs
.gitattributes
.gitignore
.gn
.mypy.ini
.prettierignore
.prettierrc.cjs
.pw_ide.yaml
.pylintrc
activate.bat
activate.sh
Android.bp
AUTHORS
bootstrap.bat
bootstrap.sh
BUILD.bazel
BUILD.gn
BUILDCONFIG.gn
CMakeLists.txt
jest.config.ts
Kconfig.zephyr
LICENSE
modules.gni
OWNERS
package-lock.json
package.json
PIGWEED_MODULES pw_build_android: Add new utils module 2024-03-13 19:54:29 +00:00
pigweed.json
README.md
rollup.config.js
tsconfig.json
WORKSPACE

Pigweed

Pigweed is an open source collection of embedded-targeted librariesor as we like to call them, modules. These modules are building blocks and infrastructure that enable faster and more reliable development on small-footprint MMU-less 32-bit microcontrollers like the STMicroelectronics STM32L452 or the Nordic nRF52832.

For more information please see our website: https://pigweed.dev/.