xref: /aosp_15_r20/external/pigweed/docs/BUILD.gn (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker# Copyright 2019 The Pigweed Authors
2*61c4878aSAndroid Build Coastguard Worker#
3*61c4878aSAndroid Build Coastguard Worker# Licensed under the Apache License, Version 2.0 (the "License"); you may not
4*61c4878aSAndroid Build Coastguard Worker# use this file except in compliance with the License. You may obtain a copy of
5*61c4878aSAndroid Build Coastguard Worker# the License at
6*61c4878aSAndroid Build Coastguard Worker#
7*61c4878aSAndroid Build Coastguard Worker#     https://www.apache.org/licenses/LICENSE-2.0
8*61c4878aSAndroid Build Coastguard Worker#
9*61c4878aSAndroid Build Coastguard Worker# Unless required by applicable law or agreed to in writing, software
10*61c4878aSAndroid Build Coastguard Worker# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11*61c4878aSAndroid Build Coastguard Worker# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12*61c4878aSAndroid Build Coastguard Worker# License for the specific language governing permissions and limitations under
13*61c4878aSAndroid Build Coastguard Worker# the License.
14*61c4878aSAndroid Build Coastguard Worker
15*61c4878aSAndroid Build Coastguard Workerimport("//build_overrides/pigweed.gni")
16*61c4878aSAndroid Build Coastguard Worker
17*61c4878aSAndroid Build Coastguard Workerimport("$dir_pw_build/python.gni")
18*61c4878aSAndroid Build Coastguard Workerimport("$dir_pw_build/python_action.gni")
19*61c4878aSAndroid Build Coastguard Workerimport("$dir_pw_docgen/docs.gni")
20*61c4878aSAndroid Build Coastguard Worker
21*61c4878aSAndroid Build Coastguard Workerpw_doc_group("static_assets") {
22*61c4878aSAndroid Build Coastguard Worker  inputs = [
23*61c4878aSAndroid Build Coastguard Worker    "_static/css/pigweed.css",
24*61c4878aSAndroid Build Coastguard Worker    "_static/js/changelog.js",
25*61c4878aSAndroid Build Coastguard Worker    "_static/js/pigweed.js",
26*61c4878aSAndroid Build Coastguard Worker    "_static/pw_logo.ico",
27*61c4878aSAndroid Build Coastguard Worker    "_static/pw_logo.svg",
28*61c4878aSAndroid Build Coastguard Worker  ]
29*61c4878aSAndroid Build Coastguard Worker}
30*61c4878aSAndroid Build Coastguard Worker
31*61c4878aSAndroid Build Coastguard Worker# Note: These may be useful for downstream projects, which is why they are
32*61c4878aSAndroid Build Coastguard Worker# split out from the overall docgen target below.
33*61c4878aSAndroid Build Coastguard Workerpw_doc_group("core_docs") {
34*61c4878aSAndroid Build Coastguard Worker  inputs = [
35*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/Kconfig.zephyr",
36*61c4878aSAndroid Build Coastguard Worker    "$dir_pw_async2/examples/coro_blinky_loop.cc",
37*61c4878aSAndroid Build Coastguard Worker    "$dir_pw_async2/public/pw_async2/coro.h",
38*61c4878aSAndroid Build Coastguard Worker    "$dir_pw_build/pigweed.bazelrc",
39*61c4878aSAndroid Build Coastguard Worker    "$dir_pw_build/py/gn_tests/BUILD.gn",
40*61c4878aSAndroid Build Coastguard Worker    "$dir_pw_build/py/pw_build/generate_python_wheel_cache.py",
41*61c4878aSAndroid Build Coastguard Worker    "$dir_pw_build/python.gni",
42*61c4878aSAndroid Build Coastguard Worker    "$dir_pw_build/python_gn_args.gni",
43*61c4878aSAndroid Build Coastguard Worker    "layout/layout.html",
44*61c4878aSAndroid Build Coastguard Worker    "run_doxygen.py",
45*61c4878aSAndroid Build Coastguard Worker  ]
46*61c4878aSAndroid Build Coastguard Worker  sources = [
47*61c4878aSAndroid Build Coastguard Worker    "3p/index.rst",
48*61c4878aSAndroid Build Coastguard Worker    "blog/01-kudzu.rst",
49*61c4878aSAndroid Build Coastguard Worker    "blog/02-bazel-feature-flags.rst",
50*61c4878aSAndroid Build Coastguard Worker    "blog/03-pigweed-sdk.rst",
51*61c4878aSAndroid Build Coastguard Worker    "blog/04-fixed-point.rst",
52*61c4878aSAndroid Build Coastguard Worker    "blog/05-coroutines.rst",
53*61c4878aSAndroid Build Coastguard Worker    "blog/index.rst",
54*61c4878aSAndroid Build Coastguard Worker    "blog/rss.xml",
55*61c4878aSAndroid Build Coastguard Worker    "code_of_conduct.rst",
56*61c4878aSAndroid Build Coastguard Worker    "code_reviews.rst",
57*61c4878aSAndroid Build Coastguard Worker    "community/index.rst",
58*61c4878aSAndroid Build Coastguard Worker    "concepts/index.rst",
59*61c4878aSAndroid Build Coastguard Worker    "contributing/docs/changelog.rst",
60*61c4878aSAndroid Build Coastguard Worker    "contributing/docs/guides.rst",
61*61c4878aSAndroid Build Coastguard Worker    "contributing/docs/index.rst",
62*61c4878aSAndroid Build Coastguard Worker    "contributing/docs/modules.rst",
63*61c4878aSAndroid Build Coastguard Worker    "contributing/index.rst",
64*61c4878aSAndroid Build Coastguard Worker    "embedded_cpp_guide.rst",
65*61c4878aSAndroid Build Coastguard Worker    "facades.rst",
66*61c4878aSAndroid Build Coastguard Worker    "faq.rst",
67*61c4878aSAndroid Build Coastguard Worker    "get_started/bazel.rst",
68*61c4878aSAndroid Build Coastguard Worker    "get_started/bazel_integration.rst",
69*61c4878aSAndroid Build Coastguard Worker    "get_started/first_time_setup.rst",
70*61c4878aSAndroid Build Coastguard Worker    "get_started/github_actions.rst",
71*61c4878aSAndroid Build Coastguard Worker    "get_started/index.rst",
72*61c4878aSAndroid Build Coastguard Worker    "get_started/install_bazel.rst",
73*61c4878aSAndroid Build Coastguard Worker    "get_started/upstream.rst",
74*61c4878aSAndroid Build Coastguard Worker    "get_started/zephyr.rst",
75*61c4878aSAndroid Build Coastguard Worker    "glossary.rst",
76*61c4878aSAndroid Build Coastguard Worker    "infra/ci_cq_intro.rst",
77*61c4878aSAndroid Build Coastguard Worker    "infra/index.rst",
78*61c4878aSAndroid Build Coastguard Worker    "infra/rollers.rst",
79*61c4878aSAndroid Build Coastguard Worker    "mission.rst",
80*61c4878aSAndroid Build Coastguard Worker    "module_structure.rst",
81*61c4878aSAndroid Build Coastguard Worker    "os/index.rst",
82*61c4878aSAndroid Build Coastguard Worker    "os/zephyr/index.rst",
83*61c4878aSAndroid Build Coastguard Worker    "os/zephyr/kconfig.rst",
84*61c4878aSAndroid Build Coastguard Worker    "overview.rst",
85*61c4878aSAndroid Build Coastguard Worker    "showcases/index.rst",
86*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/index.rst",
87*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/automate.rst",
88*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/bazel_cloud.rst",
89*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/build.rst",
90*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/code_intelligence.rst",
91*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/crash_handler.rst",
92*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/device_tests.rst",
93*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/explore.rst",
94*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/factory.rst",
95*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/flash.rst",
96*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/host_sim.rst",
97*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/host_tests.rst",
98*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/index.rst",
99*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/outro.rst",
100*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/production.rst",
101*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/rpc.rst",
102*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/setup.rst",
103*61c4878aSAndroid Build Coastguard Worker    "showcases/sense/tutorial/web.rst",
104*61c4878aSAndroid Build Coastguard Worker    "size_optimizations.rst",
105*61c4878aSAndroid Build Coastguard Worker    "style/cli.rst",
106*61c4878aSAndroid Build Coastguard Worker    "style/commit_message.rst",
107*61c4878aSAndroid Build Coastguard Worker    "style/cpp.rst",
108*61c4878aSAndroid Build Coastguard Worker    "style/doxygen.rst",
109*61c4878aSAndroid Build Coastguard Worker    "style/protobuf.rst",
110*61c4878aSAndroid Build Coastguard Worker    "style/rest.rst",
111*61c4878aSAndroid Build Coastguard Worker    "style/writing.rst",
112*61c4878aSAndroid Build Coastguard Worker    "style_guide.rst",
113*61c4878aSAndroid Build Coastguard Worker  ]
114*61c4878aSAndroid Build Coastguard Worker}
115*61c4878aSAndroid Build Coastguard Worker
116*61c4878aSAndroid Build Coastguard Worker# Documentation for upstream Pigweed targets.
117*61c4878aSAndroid Build Coastguard Workergroup("target_docs") {
118*61c4878aSAndroid Build Coastguard Worker  deps = [
119*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/android:target_docs",
120*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/apollo4:target_docs",
121*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/apollo4_pw_system:target_docs",
122*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/arduino:target_docs",
123*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/docs:target_docs",
124*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/emcraft_sf2_som:docs",
125*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/host:target_docs",
126*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/host_device_simulator:target_docs",
127*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/lm3s6965evb_qemu:target_docs",
128*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/mimxrt595_evk:target_docs",
129*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/rp2040:target_docs",
130*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/stm32f429i_disc1:target_docs",
131*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/targets/stm32f429i_disc1_stm32cube:target_docs",
132*61c4878aSAndroid Build Coastguard Worker  ]
133*61c4878aSAndroid Build Coastguard Worker}
134*61c4878aSAndroid Build Coastguard Worker
135*61c4878aSAndroid Build Coastguard Workergroup("module_docs") {
136*61c4878aSAndroid Build Coastguard Worker  deps = pw_module_docs
137*61c4878aSAndroid Build Coastguard Worker}
138*61c4878aSAndroid Build Coastguard Worker
139*61c4878aSAndroid Build Coastguard Workergroup("third_party_docs") {
140*61c4878aSAndroid Build Coastguard Worker  deps = [
141*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/abseil-cpp:docs",
142*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/boringssl:docs",
143*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/emboss:docs",
144*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/freertos:docs",
145*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/fuchsia:docs",
146*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/fuzztest:docs",
147*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/googletest:docs",
148*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/nanopb:docs",
149*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/perfetto:docs",
150*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/re2:docs",
151*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/third_party/tinyusb:docs",
152*61c4878aSAndroid Build Coastguard Worker  ]
153*61c4878aSAndroid Build Coastguard Worker}
154*61c4878aSAndroid Build Coastguard Worker
155*61c4878aSAndroid Build Coastguard Worker# All sources with doxygen comment blocks.
156*61c4878aSAndroid Build Coastguard Worker_doxygen_input_files = [  # keep-sorted: start
157*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_alignment/public/pw_alignment/alignment.h",
158*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/block/public/pw_allocator/block/alignable.h",
159*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/block/public/pw_allocator/block/allocatable.h",
160*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/block/public/pw_allocator/block/basic.h",
161*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/block/public/pw_allocator/block/contiguous.h",
162*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/block/public/pw_allocator/block/detailed_block.h",
163*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/block/public/pw_allocator/block/iterable.h",
164*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/block/public/pw_allocator/block/poisonable.h",
165*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/block/public/pw_allocator/block/result.h",
166*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/block/public/pw_allocator/block/with_layout.h",
167*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/bucket/public/pw_allocator/bucket/fast_sorted.h",
168*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/bucket/public/pw_allocator/bucket/sequenced.h",
169*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/bucket/public/pw_allocator/bucket/sorted.h",
170*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/bucket/public/pw_allocator/bucket/unordered.h",
171*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/allocator.h",
172*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/allocator_as_pool.h",
173*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/best_fit.h",
174*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/block_allocator.h",
175*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/bucket_allocator.h",
176*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/buddy_allocator.h",
177*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/buffer.h",
178*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/bump_allocator.h",
179*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/capability.h",
180*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/chunk_pool.h",
181*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/config.h",
182*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/deallocator.h",
183*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/fallback_allocator.h",
184*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/first_fit.h",
185*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/fragmentation.h",
186*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/fuzzing.h",
187*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/layout.h",
188*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/libc_allocator.h",
189*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/metrics.h",
190*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/null_allocator.h",
191*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/pmr_allocator.h",
192*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/pool.h",
193*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/size_reporter.h",
194*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/synchronized_allocator.h",
195*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/test_harness.h",
196*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/testing.h",
197*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/tracking_allocator.h",
198*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/typed_pool.h",
199*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/unique_ptr.h",
200*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_allocator/public/pw_allocator/worst_fit.h",
201*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_analog/public/pw_analog/analog_input.h",
202*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_analog/public/pw_analog/microvolt_input.h",
203*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async/public/pw_async/context.h",
204*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async/public/pw_async/dispatcher.h",
205*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async/public/pw_async/fake_dispatcher_fixture.h",
206*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async/public/pw_async/function_dispatcher.h",
207*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async/public/pw_async/heap_dispatcher.h",
208*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async/public/pw_async/task.h",
209*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async/public/pw_async/task_function.h",
210*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/allocate_task.h",
211*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/coro.h",
212*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/coro_or_else_task.h",
213*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/dispatcher.h",
214*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/dispatcher_base.h",
215*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/enqueue_heap_func.h",
216*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/join.h",
217*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/once_sender.h",
218*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/pend_func_task.h",
219*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/pendable_as_task.h",
220*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/poll.h",
221*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/simulated_time_provider.h",
222*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/system_time_provider.h",
223*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2/public/pw_async2/time_provider.h",
224*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async2_basic/public_overrides/pw_async2/dispatcher_native.h",
225*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_async_basic/public/pw_async_basic/dispatcher.h",
226*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_base64/public/pw_base64/base64.h",
227*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth/public/pw_bluetooth/controller2.h",
228*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth/public/pw_bluetooth/gatt/client2.h",
229*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth/public/pw_bluetooth/gatt/server2.h",
230*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth/public/pw_bluetooth/low_energy/central2.h",
231*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth/public/pw_bluetooth/low_energy/channel.h",
232*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth/public/pw_bluetooth/low_energy/connection2.h",
233*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth/public/pw_bluetooth/low_energy/peripheral2.h",
234*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth_proxy/public/pw_bluetooth_proxy/h4_packet.h",
235*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth_proxy/public/pw_bluetooth_proxy/proxy_host.h",
236*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bluetooth_sapphire/public/pw_bluetooth_sapphire/peripheral.h",
237*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_build/public/pw_build/linker_symbol.h",
238*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_build/public/pw_build/must_place.ld.h",
239*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bytes/public/pw_bytes/alignment.h",
240*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bytes/public/pw_bytes/bit.h",
241*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bytes/public/pw_bytes/byte_builder.h",
242*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_bytes/public/pw_bytes/packed_ptr.h",
243*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_channel/public/pw_channel/channel.h",
244*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_channel/public/pw_channel/epoll_channel.h",
245*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_channel/public/pw_channel/forwarding_channel.h",
246*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_channel/public/pw_channel/loopback_channel.h",
247*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_channel/public/pw_channel/rp2_stdio_channel.h",
248*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_channel/public/pw_channel/stream_channel.h",
249*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_chre/public/pw_chre/chre.h",
250*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_chre/public/pw_chre/host_link.h",
251*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_chrono/public/pw_chrono/simulated_system_clock.h",
252*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_chrono/public/pw_chrono/system_clock.h",
253*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_chrono/public/pw_chrono/system_timer.h",
254*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_chrono/public/pw_chrono/virtual_clock.h",
255*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_clock_tree/public/pw_clock_tree/clock_tree.h",
256*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_clock_tree_mcuxpresso/public/pw_clock_tree_mcuxpresso/clock_tree.h",
257*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/filtered_view.h",
258*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/inline_deque.h",
259*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/inline_queue.h",
260*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/inline_var_len_entry_queue.h",
261*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/internal/aa_tree.h",
262*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/internal/intrusive_list.h",
263*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/intrusive_forward_list.h",
264*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/intrusive_list.h",
265*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/intrusive_map.h",
266*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/intrusive_multimap.h",
267*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/intrusive_multiset.h",
268*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_containers/public/pw_containers/intrusive_set.h",
269*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_crypto/public/pw_crypto/ecdsa.h",
270*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_crypto/public/pw_crypto/sha256.h",
271*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_digital_io/public/pw_digital_io/digital_io.h",
272*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_digital_io/public/pw_digital_io/digital_io_mock.h",
273*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_display/public/pw_display/color.h",
274*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_elf/public/pw_elf/reader.h",
275*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_function/public/pw_function/function.h",
276*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_function/public/pw_function/pointer.h",
277*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_function/public/pw_function/scope_guard.h",
278*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_hdlc/public/pw_hdlc/decoder.h",
279*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_hdlc/public/pw_hdlc/encoder.h",
280*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_hdlc/public/pw_hdlc/router.h",
281*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_hex_dump/public/pw_hex_dump/hex_dump.h",
282*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_hex_dump/public/pw_hex_dump/log_bytes.h",
283*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_i2c/public/pw_i2c/address.h",
284*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_i2c/public/pw_i2c/device.h",
285*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_i2c/public/pw_i2c/i2c_service.h",
286*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_i2c/public/pw_i2c/initiator.h",
287*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_i2c/public/pw_i2c/initiator_gmock.h",
288*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_i2c/public/pw_i2c/initiator_mock.h",
289*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_i2c/public/pw_i2c/register_device.h",
290*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_i2c_linux/public/pw_i2c_linux/initiator.h",
291*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_interrupt/public/pw_interrupt/context.h",
292*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_json/public/pw_json/builder.h",
293*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_kvs/public/pw_kvs/key_value_store.h",
294*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_kvs/pw_kvs_private/config.h",
295*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_log/public/pw_log/tokenized_args.h",
296*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_log_string/public/pw_log_string/handler.h",
297*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_log_tokenized/public/pw_log_tokenized/base64.h",
298*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_log_tokenized/public/pw_log_tokenized/config.h",
299*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_log_tokenized/public/pw_log_tokenized/handler.h",
300*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_log_tokenized/public/pw_log_tokenized/metadata.h",
301*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_malloc/public/pw_malloc/config.h",
302*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_malloc/public/pw_malloc/malloc.h",
303*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_multibuf/public/pw_multibuf/allocator.h",
304*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_multibuf/public/pw_multibuf/chunk.h",
305*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_multibuf/public/pw_multibuf/from_span.h",
306*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_multibuf/public/pw_multibuf/header_chunk_region_tracker.h",
307*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_multibuf/public/pw_multibuf/multibuf.h",
308*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_multibuf/public/pw_multibuf/simple_allocator.h",
309*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_multibuf/public/pw_multibuf/simple_allocator_for_test.h",
310*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_multibuf/public/pw_multibuf/single_chunk_region_tracker.h",
311*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_multibuf/public/pw_multibuf/stream.h",
312*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_numeric/public/pw_numeric/integer_division.h",
313*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_perf_test/public/pw_perf_test/event_handler.h",
314*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_perf_test/public/pw_perf_test/perf_test.h",
315*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_polyfill/public/pw_polyfill/language_feature_macros.h",
316*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_polyfill/public/pw_polyfill/standard.h",
317*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_preprocessor/public/pw_preprocessor/apply.h",
318*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_preprocessor/public/pw_preprocessor/compiler.h",
319*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_protobuf/public/pw_protobuf/find.h",
320*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_random/public/pw_random/random.h",
321*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_random/public/pw_random/xor_shift.h",
322*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_rpc/public/pw_rpc/channel.h",
323*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_rpc/public/pw_rpc/internal/config.h",
324*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_rpc/public/pw_rpc/synchronous_call.h",
325*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_span/public/pw_span/internal/config.h",
326*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_spi/public/pw_spi/chip_selector.h",
327*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_spi/public/pw_spi/chip_selector_digital_out.h",
328*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_status/public/pw_status/status.h",
329*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_status/public/pw_status/status_with_size.h",
330*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_status/public/pw_status/try.h",
331*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_stream/public/pw_stream/stream.h",
332*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_stream_uart_linux/public/pw_stream_uart_linux/stream.h",
333*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_string/public/pw_string/format.h",
334*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_string/public/pw_string/string.h",
335*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_string/public/pw_string/string_builder.h",
336*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_string/public/pw_string/utf_codecs.h",
337*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_string/public/pw_string/util.h",
338*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/binary_semaphore.h",
339*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/borrow.h",
340*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/counting_semaphore.h",
341*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/inline_borrowable.h",
342*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/interrupt_spin_lock.h",
343*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/lock_annotations.h",
344*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/mutex.h",
345*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/thread_notification.h",
346*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/timed_mutex.h",
347*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/timed_thread_notification.h",
348*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sync/public/pw_sync/virtual_basic_lockable.h",
349*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_sys_io/public/pw_sys_io/sys_io.h",
350*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_system/public/pw_system/system.h",
351*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_third_party/freertos/pw_assert_stack_overflow_hook.cc",
352*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_third_party/freertos/static_task_allocation.cc",
353*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_thread/public/pw_thread/options.h",
354*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_thread/public/pw_thread/test_thread_context.h",
355*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_thread/public/pw_thread/thread.h",
356*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_tokenizer/public/pw_tokenizer/config.h",
357*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_tokenizer/public/pw_tokenizer/detokenize.h",
358*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_tokenizer/public/pw_tokenizer/encode_args.h",
359*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_tokenizer/public/pw_tokenizer/enum.h",
360*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_tokenizer/public/pw_tokenizer/nested_tokenization.h",
361*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_tokenizer/public/pw_tokenizer/token_database.h",
362*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_tokenizer/public/pw_tokenizer/tokenize.h",
363*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_toolchain/public/pw_toolchain/no_destructor.h",
364*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_transfer/public/pw_transfer/atomic_file_transfer_handler.h",
365*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_uart/public/pw_uart/blocking_adapter.h",
366*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_uart/public/pw_uart/stream.h",
367*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_uart/public/pw_uart/uart.h",
368*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_uart/public/pw_uart/uart_base.h",
369*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_uart/public/pw_uart/uart_non_blocking.h",
370*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/light_public_overrides/pw_unit_test/framework_backend.h",
371*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/config.h",
372*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/event_handler.h",
373*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/googletest_handler_adapter.h",
374*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/googletest_style_event_handler.h",
375*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/logging_event_handler.h",
376*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/multi_event_handler.h",
377*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/printf_event_handler.h",
378*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/simple_printing_event_handler.h",
379*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/static_library_support.h",
380*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/status_macros.h",
381*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_unit_test/public/pw_unit_test/test_record_event_handler.h",
382*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_varint/public/pw_varint/stream.h",
383*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_varint/public/pw_varint/varint.h",
384*61c4878aSAndroid Build Coastguard Worker  "$dir_pw_work_queue/public/pw_work_queue/work_queue.h",
385*61c4878aSAndroid Build Coastguard Worker]  # keep-sorted: end
386*61c4878aSAndroid Build Coastguard Worker
387*61c4878aSAndroid Build Coastguard Workerpw_python_action("generate_doxygen") {
388*61c4878aSAndroid Build Coastguard Worker  _output_dir = "docs/doxygen"
389*61c4878aSAndroid Build Coastguard Worker  script = "run_doxygen.py"
390*61c4878aSAndroid Build Coastguard Worker  inputs = [
391*61c4878aSAndroid Build Coastguard Worker    "//PIGWEED_MODULES",
392*61c4878aSAndroid Build Coastguard Worker    "Doxyfile",
393*61c4878aSAndroid Build Coastguard Worker  ]
394*61c4878aSAndroid Build Coastguard Worker  inputs += _doxygen_input_files
395*61c4878aSAndroid Build Coastguard Worker  args = [
396*61c4878aSAndroid Build Coastguard Worker    "--gn-root",
397*61c4878aSAndroid Build Coastguard Worker    rebase_path("//", root_build_dir),
398*61c4878aSAndroid Build Coastguard Worker    "--pigweed-modules-file",
399*61c4878aSAndroid Build Coastguard Worker    rebase_path("//PIGWEED_MODULES", root_build_dir),
400*61c4878aSAndroid Build Coastguard Worker    "--output-dir",
401*61c4878aSAndroid Build Coastguard Worker    _output_dir,
402*61c4878aSAndroid Build Coastguard Worker    "--doxygen-config",
403*61c4878aSAndroid Build Coastguard Worker    rebase_path("Doxyfile", root_build_dir),
404*61c4878aSAndroid Build Coastguard Worker    "--include-paths",
405*61c4878aSAndroid Build Coastguard Worker  ]
406*61c4878aSAndroid Build Coastguard Worker  args += rebase_path(_doxygen_input_files, root_build_dir)
407*61c4878aSAndroid Build Coastguard Worker  outputs = [
408*61c4878aSAndroid Build Coastguard Worker    "$root_build_dir/$_output_dir/html/index.html",
409*61c4878aSAndroid Build Coastguard Worker    "$root_build_dir/$_output_dir/xml/index.xml",
410*61c4878aSAndroid Build Coastguard Worker  ]
411*61c4878aSAndroid Build Coastguard Worker}
412*61c4878aSAndroid Build Coastguard Worker
413*61c4878aSAndroid Build Coastguard Workerpw_doc_gen("docs") {
414*61c4878aSAndroid Build Coastguard Worker  conf = "conf.py"
415*61c4878aSAndroid Build Coastguard Worker  sources = [
416*61c4878aSAndroid Build Coastguard Worker    # Note: These must use the "docs" prefix for links and image references. In
417*61c4878aSAndroid Build Coastguard Worker    # contrast, the pw_doc_group above should not use the docs prefix.
418*61c4878aSAndroid Build Coastguard Worker    "automated_analysis.rst",
419*61c4878aSAndroid Build Coastguard Worker    "bazel_compatibility.rst",
420*61c4878aSAndroid Build Coastguard Worker    "build_system.rst",
421*61c4878aSAndroid Build Coastguard Worker    "changelog.rst",
422*61c4878aSAndroid Build Coastguard Worker    "index.rst",
423*61c4878aSAndroid Build Coastguard Worker    "modules.rst",
424*61c4878aSAndroid Build Coastguard Worker    "python_build.rst",
425*61c4878aSAndroid Build Coastguard Worker    "targets.rst",
426*61c4878aSAndroid Build Coastguard Worker    "third_party_support.rst",
427*61c4878aSAndroid Build Coastguard Worker  ]
428*61c4878aSAndroid Build Coastguard Worker  output_directory = target_gen_dir
429*61c4878aSAndroid Build Coastguard Worker  deps = [
430*61c4878aSAndroid Build Coastguard Worker    ":core_docs",
431*61c4878aSAndroid Build Coastguard Worker    ":generate_doxygen",
432*61c4878aSAndroid Build Coastguard Worker    ":module_docs",
433*61c4878aSAndroid Build Coastguard Worker    ":static_assets",
434*61c4878aSAndroid Build Coastguard Worker    ":target_docs",
435*61c4878aSAndroid Build Coastguard Worker    ":third_party_docs",
436*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/kudzu:docs",
437*61c4878aSAndroid Build Coastguard Worker    "$dir_pigweed/seed:docs",
438*61c4878aSAndroid Build Coastguard Worker  ]
439*61c4878aSAndroid Build Coastguard Worker
440*61c4878aSAndroid Build Coastguard Worker  # Extra Python deps are required to set the PYTHONPATH so
441*61c4878aSAndroid Build Coastguard Worker  # automodule, autoclass or autofunction RST directives work in
442*61c4878aSAndroid Build Coastguard Worker  # sphinx.
443*61c4878aSAndroid Build Coastguard Worker  python_deps = [ "$dir_pw_env_setup:core_pigweed_python_packages" ]
444*61c4878aSAndroid Build Coastguard Worker}
445