Alexei Frolov | 0efdb11 | 2019-11-14 17:22:08 -0800 | [diff] [blame] | 1 | # Copyright 2019 The Pigweed Authors |
| 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | # use this file except in compliance with the License. You may obtain a copy of |
| 5 | # the License at |
| 6 | # |
| 7 | # https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | # License for the specific language governing permissions and limitations under |
| 13 | # the License. |
| 14 | |
Armando Montanez | fb3d3fb | 2020-06-09 18:12:12 -0700 | [diff] [blame] | 15 | import("//build_overrides/pigweed.gni") |
Alexei Frolov | 0efdb11 | 2019-11-14 17:22:08 -0800 | [diff] [blame] | 16 | |
Armando Montanez | fb3d3fb | 2020-06-09 18:12:12 -0700 | [diff] [blame] | 17 | import("$dir_pw_docgen/docs.gni") |
Wyatt Hepler | d49f8fe | 2020-10-15 10:13:47 -0700 | [diff] [blame] | 18 | |
Keir Mierle | 72cae43 | 2021-04-10 02:03:40 -0700 | [diff] [blame] | 19 | # Note: These may be useful for downstream projects, which is why they are |
| 20 | # split out from the overall docgen target below. |
Keir Mierle | 2c1e56b | 2019-11-15 16:32:11 -0800 | [diff] [blame] | 21 | pw_doc_group("core_docs") { |
Armando Montanez | 1d00120 | 2020-03-04 11:51:32 -0800 | [diff] [blame] | 22 | inputs = [ |
Armando Montanez | 4db74e1 | 2020-03-17 15:55:59 -0700 | [diff] [blame] | 23 | "images/pw_env_setup_demo.gif", |
Armando Montanez | bcc194b | 2020-03-10 10:23:18 -0700 | [diff] [blame] | 24 | "images/pw_status_test.png", |
Armando Montanez | 1d00120 | 2020-03-04 11:51:32 -0800 | [diff] [blame] | 25 | "images/pw_watch_build_demo.gif", |
Armando Montanez | bcc194b | 2020-03-10 10:23:18 -0700 | [diff] [blame] | 26 | "images/pw_watch_on_device_demo.gif", |
Armando Montanez | 1d00120 | 2020-03-04 11:51:32 -0800 | [diff] [blame] | 27 | "images/pw_watch_test_demo.gif", |
| 28 | "images/stm32f429i-disc1_connected.jpg", |
Keir Mierle | b191402 | 2021-04-12 09:08:33 -0700 | [diff] [blame] | 29 | |
| 30 | # TODO(pwbug/368): This should be in the pw_doc_gen target instead of here. |
| 31 | "_static/css/pigweed.css", |
Armando Montanez | 1d00120 | 2020-03-04 11:51:32 -0800 | [diff] [blame] | 32 | ] |
Keir Mierle | 2c1e56b | 2019-11-15 16:32:11 -0800 | [diff] [blame] | 33 | sources = [ |
Keir Mierle | 72cae43 | 2021-04-10 02:03:40 -0700 | [diff] [blame] | 34 | "code_of_conduct.rst", |
| 35 | "contributing.rst", |
Keir Mierle | 2c1e56b | 2019-11-15 16:32:11 -0800 | [diff] [blame] | 36 | "embedded_cpp_guide.rst", |
Keir Mierle | eaa7e92 | 2020-07-24 14:30:47 -0700 | [diff] [blame] | 37 | "faq.rst", |
Keir Mierle | 72cae43 | 2021-04-10 02:03:40 -0700 | [diff] [blame] | 38 | "getting_started.rst", |
Keir Mierle | 086ef1c | 2020-03-19 02:03:51 -0700 | [diff] [blame] | 39 | "module_structure.rst", |
Ewout van Bekkum | cc756c8 | 2021-05-12 07:57:43 -0700 | [diff] [blame] | 40 | "os_abstraction_layers.rst", |
Keir Mierle | 2c1e56b | 2019-11-15 16:32:11 -0800 | [diff] [blame] | 41 | "style_guide.rst", |
| 42 | ] |
| 43 | } |
| 44 | |
Armando Montanez | 0874558 | 2019-12-12 10:51:50 -0800 | [diff] [blame] | 45 | # Documentation for upstream Pigweed targets. |
| 46 | group("target_docs") { |
Armando Montanez | 3d92e81 | 2020-03-19 12:13:36 -0700 | [diff] [blame] | 47 | deps = [ |
Anthony DiGirolamo | eea0d77 | 2020-08-06 12:00:36 -0700 | [diff] [blame] | 48 | "$dir_pigweed/targets/arduino:target_docs", |
Armando Montanez | 3d92e81 | 2020-03-19 12:13:36 -0700 | [diff] [blame] | 49 | "$dir_pigweed/targets/docs:target_docs", |
| 50 | "$dir_pigweed/targets/host:target_docs", |
Rob Mohr | 3d61b32 | 2021-05-17 10:52:24 -0700 | [diff] [blame] | 51 | "$dir_pigweed/targets/lm3s6965evb_qemu:target_docs", |
| 52 | "$dir_pigweed/targets/stm32f429i_disc1:target_docs", |
Armando Montanez | 3d92e81 | 2020-03-19 12:13:36 -0700 | [diff] [blame] | 53 | ] |
Armando Montanez | 0874558 | 2019-12-12 10:51:50 -0800 | [diff] [blame] | 54 | } |
| 55 | |
Alexei Frolov | 216808f | 2020-09-08 14:01:45 -0700 | [diff] [blame] | 56 | group("module_docs") { |
Alexei Frolov | 0efdb11 | 2019-11-14 17:22:08 -0800 | [diff] [blame] | 57 | deps = [ |
Rob Mohr | e916d32 | 2020-07-17 09:07:32 -0700 | [diff] [blame] | 58 | "$dir_docker:docs", |
Armando Montanez | ccc3ee1 | 2020-06-11 16:36:11 -0700 | [diff] [blame] | 59 | "$dir_pw_allocator:docs", |
Ewout van Bekkum | e541248 | 2021-05-12 17:28:32 -0700 | [diff] [blame] | 60 | "$dir_pw_analog:docs", |
Anthony DiGirolamo | 9147aa0 | 2020-09-22 10:41:05 -0700 | [diff] [blame] | 61 | "$dir_pw_arduino_build:docs", |
Keir Mierle | 3cee879 | 2020-01-22 17:08:13 -0800 | [diff] [blame] | 62 | "$dir_pw_assert:docs", |
Keir Mierle | ec9bf1b | 2020-03-03 10:27:01 -0800 | [diff] [blame] | 63 | "$dir_pw_assert_basic:docs", |
Keir Mierle | b776cb2 | 2020-08-14 16:46:50 -0700 | [diff] [blame] | 64 | "$dir_pw_assert_log:docs", |
Armando Montanez | 0054a9b | 2020-03-13 13:06:24 -0700 | [diff] [blame] | 65 | "$dir_pw_base64:docs", |
Alexei Frolov | 0efdb11 | 2019-11-14 17:22:08 -0800 | [diff] [blame] | 66 | "$dir_pw_bloat:docs", |
David Rogers | 2d19502 | 2020-07-16 14:07:47 -0700 | [diff] [blame] | 67 | "$dir_pw_blob_store:docs", |
Armando Montanez | 7009566 | 2020-01-09 14:25:04 -0800 | [diff] [blame] | 68 | "$dir_pw_boot_armv7m:docs", |
Rob Mohr | 49de492 | 2019-12-10 20:10:41 -0800 | [diff] [blame] | 69 | "$dir_pw_build:docs", |
shaneajg | 9c19db4 | 2020-06-11 15:49:51 -0400 | [diff] [blame] | 70 | "$dir_pw_bytes:docs", |
Wyatt Hepler | 3c4e5de | 2020-03-03 14:37:52 -0800 | [diff] [blame] | 71 | "$dir_pw_checksum:docs", |
Ewout van Bekkum | 3c61ae9 | 2020-10-30 15:52:25 -0700 | [diff] [blame] | 72 | "$dir_pw_chrono:docs", |
Ewout van Bekkum | a25df5f | 2021-04-09 18:10:49 -0700 | [diff] [blame] | 73 | "$dir_pw_chrono_embos:docs", |
| 74 | "$dir_pw_chrono_freertos:docs", |
Ewout van Bekkum | 3c61ae9 | 2020-10-30 15:52:25 -0700 | [diff] [blame] | 75 | "$dir_pw_chrono_stl:docs", |
Ewout van Bekkum | a25df5f | 2021-04-09 18:10:49 -0700 | [diff] [blame] | 76 | "$dir_pw_chrono_threadx:docs", |
Armando Montanez | 0054a9b | 2020-03-13 13:06:24 -0700 | [diff] [blame] | 77 | "$dir_pw_cli:docs", |
Anthony DiGirolamo | 26ed98a | 2021-06-11 14:50:29 -0700 | [diff] [blame] | 78 | "$dir_pw_console:docs", |
Wyatt Hepler | 3c4e5de | 2020-03-03 14:37:52 -0800 | [diff] [blame] | 79 | "$dir_pw_containers:docs", |
Armando Montanez | 5104cd6 | 2019-12-10 14:36:43 -0800 | [diff] [blame] | 80 | "$dir_pw_cpu_exception:docs", |
Armando Montanez | a9ca999 | 2021-01-26 17:06:10 -0800 | [diff] [blame] | 81 | "$dir_pw_cpu_exception_cortex_m:docs", |
Alexei Frolov | 8ffcb91 | 2019-11-18 11:00:20 -0800 | [diff] [blame] | 82 | "$dir_pw_docgen:docs", |
Rob Mohr | f82e7a8 | 2020-01-03 13:50:11 -0800 | [diff] [blame] | 83 | "$dir_pw_doctor:docs", |
Rob Mohr | d45e234 | 2020-03-03 15:02:18 -0800 | [diff] [blame] | 84 | "$dir_pw_env_setup:docs", |
Alexei Frolov | 99de52d | 2021-05-11 19:58:01 -0700 | [diff] [blame] | 85 | "$dir_pw_function:docs", |
Aaron Green | f3c3d2b | 2020-04-02 23:12:31 -0700 | [diff] [blame] | 86 | "$dir_pw_fuzzer:docs", |
Alexei Frolov | d3e5cb7 | 2021-01-08 13:08:45 -0800 | [diff] [blame] | 87 | "$dir_pw_hdlc:docs", |
Armando Montanez | 593d0d5 | 2020-07-08 19:55:01 -0700 | [diff] [blame] | 88 | "$dir_pw_hex_dump:docs", |
Armando Montanez | e1b7fd7 | 2021-05-12 17:04:10 -0700 | [diff] [blame] | 89 | "$dir_pw_i2c:docs", |
Ewout van Bekkum | bd4906c | 2020-11-11 13:42:13 -0800 | [diff] [blame] | 90 | "$dir_pw_interrupt:docs", |
| 91 | "$dir_pw_interrupt_cortex_m:docs", |
Armando Montanez | 0054a9b | 2020-03-13 13:06:24 -0700 | [diff] [blame] | 92 | "$dir_pw_kvs:docs", |
Keir Mierle | 32829d3 | 2020-11-25 15:38:40 -0800 | [diff] [blame] | 93 | "$dir_pw_libc:docs", |
Keir Mierle | af5e358 | 2019-12-30 13:11:05 -0800 | [diff] [blame] | 94 | "$dir_pw_log:docs", |
Armando Montanez | 0054a9b | 2020-03-13 13:06:24 -0700 | [diff] [blame] | 95 | "$dir_pw_log_basic:docs", |
Prashanth Swaminathan | 5ef2aa2 | 2020-11-10 09:57:46 -0800 | [diff] [blame] | 96 | "$dir_pw_log_multisink:docs", |
Wyatt Hepler | 24a6e27 | 2020-09-01 10:25:28 -0700 | [diff] [blame] | 97 | "$dir_pw_log_null:docs", |
Prashanth Swaminathan | e9cf376 | 2020-09-23 10:01:29 -0700 | [diff] [blame] | 98 | "$dir_pw_log_rpc:docs", |
Prashanth Swaminathan | 49a4a82 | 2021-01-12 18:41:52 -0800 | [diff] [blame] | 99 | "$dir_pw_log_sink:docs", |
Wyatt Hepler | cb725c1 | 2020-05-01 11:05:01 -0700 | [diff] [blame] | 100 | "$dir_pw_log_tokenized:docs", |
Ewout van Bekkum | e541248 | 2021-05-12 17:28:32 -0700 | [diff] [blame] | 101 | "$dir_pw_malloc:docs", |
| 102 | "$dir_pw_malloc_freelist:docs", |
Keir Mierle | 45fa785 | 2020-08-10 21:09:54 -0700 | [diff] [blame] | 103 | "$dir_pw_metric:docs", |
Wyatt Hepler | 0412a7d | 2020-01-28 16:27:32 -0800 | [diff] [blame] | 104 | "$dir_pw_minimal_cpp_stdlib:docs", |
Keir Mierle | c34f71f | 2019-12-06 12:44:47 -0800 | [diff] [blame] | 105 | "$dir_pw_module:docs", |
Prashanth Swaminathan | f36832a | 2021-01-27 16:20:32 -0800 | [diff] [blame] | 106 | "$dir_pw_multisink:docs", |
Rob Mohr | 0b6a502 | 2020-10-22 11:10:24 -0700 | [diff] [blame] | 107 | "$dir_pw_package:docs", |
Ewout van Bekkum | 32dc5c5 | 2021-03-16 11:35:37 -0700 | [diff] [blame] | 108 | "$dir_pw_persistent_ram:docs", |
Wyatt Hepler | c542a5d | 2020-01-15 15:43:10 -0800 | [diff] [blame] | 109 | "$dir_pw_polyfill:docs", |
Alexei Frolov | 0efdb11 | 2019-11-14 17:22:08 -0800 | [diff] [blame] | 110 | "$dir_pw_preprocessor:docs", |
Wyatt Hepler | ee3e02f | 2019-12-05 10:52:31 -0800 | [diff] [blame] | 111 | "$dir_pw_presubmit:docs", |
Alexei Frolov | 9c2ed46 | 2020-01-13 15:35:42 -0800 | [diff] [blame] | 112 | "$dir_pw_protobuf:docs", |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 113 | "$dir_pw_protobuf_compiler:docs", |
Armando Montanez | 47008e8 | 2020-08-04 11:04:45 -0700 | [diff] [blame] | 114 | "$dir_pw_random:docs", |
Alexei Frolov | 41b32d3 | 2019-11-13 17:22:03 -0800 | [diff] [blame] | 115 | "$dir_pw_result:docs", |
Keir Mierle | 866cff4 | 2020-04-28 22:24:44 -0700 | [diff] [blame] | 116 | "$dir_pw_ring_buffer:docs", |
Alexei Frolov | 5af57d1 | 2021-01-12 11:38:06 -0800 | [diff] [blame] | 117 | "$dir_pw_router:docs", |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 118 | "$dir_pw_rpc:docs", |
Armando Montanez | 179aa8e | 2021-03-10 11:46:35 -0800 | [diff] [blame] | 119 | "$dir_pw_snapshot:docs", |
Wyatt Hepler | ee3e02f | 2019-12-05 10:52:31 -0800 | [diff] [blame] | 120 | "$dir_pw_span:docs", |
| 121 | "$dir_pw_status:docs", |
Varun Sharma | 708d38c | 2021-04-29 09:03:12 -0700 | [diff] [blame] | 122 | "$dir_pw_stm32cube_build:docs", |
Armando Montanez | 0bcae73 | 2020-05-27 13:28:11 -0700 | [diff] [blame] | 123 | "$dir_pw_stream:docs", |
Wyatt Hepler | fe85de2 | 2019-11-19 17:10:20 -0800 | [diff] [blame] | 124 | "$dir_pw_string:docs", |
Ewout van Bekkum | 5890193 | 2020-11-09 12:46:52 -0800 | [diff] [blame] | 125 | "$dir_pw_sync:docs", |
Prashanth Swaminathan | acbd070 | 2021-01-22 11:58:15 -0800 | [diff] [blame] | 126 | "$dir_pw_sync_baremetal:docs", |
Ewout van Bekkum | 3b9eca4 | 2021-04-02 14:54:02 -0700 | [diff] [blame] | 127 | "$dir_pw_sync_embos:docs", |
| 128 | "$dir_pw_sync_freertos:docs", |
Ewout van Bekkum | 5890193 | 2020-11-09 12:46:52 -0800 | [diff] [blame] | 129 | "$dir_pw_sync_stl:docs", |
Ewout van Bekkum | 5bcd8c4 | 2020-11-23 10:46:16 -0800 | [diff] [blame] | 130 | "$dir_pw_sync_threadx:docs", |
Armando Montanez | f7a5a74 | 2020-03-02 14:58:59 -0800 | [diff] [blame] | 131 | "$dir_pw_sys_io:docs", |
Anthony DiGirolamo | eea0d77 | 2020-08-06 12:00:36 -0700 | [diff] [blame] | 132 | "$dir_pw_sys_io_arduino:docs", |
Armando Montanez | f7a5a74 | 2020-03-02 14:58:59 -0800 | [diff] [blame] | 133 | "$dir_pw_sys_io_baremetal_stm32f429:docs", |
| 134 | "$dir_pw_sys_io_stdio:docs", |
Alexei Frolov | 300dcea | 2019-12-23 13:33:59 -0800 | [diff] [blame] | 135 | "$dir_pw_target_runner:docs", |
Ewout van Bekkum | f4da489 | 2021-03-05 15:05:37 -0800 | [diff] [blame] | 136 | "$dir_pw_thread:docs", |
Ewout van Bekkum | a25df5f | 2021-04-09 18:10:49 -0700 | [diff] [blame] | 137 | "$dir_pw_thread_embos:docs", |
| 138 | "$dir_pw_thread_freertos:docs", |
| 139 | "$dir_pw_thread_stl:docs", |
Ewout van Bekkum | f4da489 | 2021-03-05 15:05:37 -0800 | [diff] [blame] | 140 | "$dir_pw_thread_threadx:docs", |
Yecheng Zhao | 08dd6a5 | 2021-05-10 15:50:22 -0700 | [diff] [blame] | 141 | "$dir_pw_tls_client:docs", |
Wyatt Hepler | 80c6ee5 | 2020-01-03 09:54:58 -0800 | [diff] [blame] | 142 | "$dir_pw_tokenizer:docs", |
Armando Montanez | 0054a9b | 2020-03-13 13:06:24 -0700 | [diff] [blame] | 143 | "$dir_pw_toolchain:docs", |
Robert Oliver | d1323f4 | 2020-04-27 12:05:16 -0400 | [diff] [blame] | 144 | "$dir_pw_trace:docs", |
Robert Oliver | 21dcf27 | 2020-05-12 15:41:52 -0400 | [diff] [blame] | 145 | "$dir_pw_trace_tokenized:docs", |
Wyatt Hepler | 1e63673 | 2021-06-14 18:30:13 -0700 | [diff] [blame] | 146 | "$dir_pw_transfer:docs", |
Alexei Frolov | ea39552 | 2020-03-13 13:35:07 -0700 | [diff] [blame] | 147 | "$dir_pw_unit_test:docs", |
Wyatt Hepler | 3c4e5de | 2020-03-03 14:37:52 -0800 | [diff] [blame] | 148 | "$dir_pw_varint:docs", |
Armando Montanez | bcc194b | 2020-03-10 10:23:18 -0700 | [diff] [blame] | 149 | "$dir_pw_watch:docs", |
Matthew Soulanille | 376d797 | 2020-06-01 15:50:07 -0700 | [diff] [blame] | 150 | "$dir_pw_web_ui:docs", |
Alexei Frolov | 0efdb11 | 2019-11-14 17:22:08 -0800 | [diff] [blame] | 151 | ] |
| 152 | } |
Alexei Frolov | 216808f | 2020-09-08 14:01:45 -0700 | [diff] [blame] | 153 | |
| 154 | pw_doc_gen("docs") { |
| 155 | conf = "conf.py" |
| 156 | sources = [ |
Keir Mierle | b191402 | 2021-04-12 09:08:33 -0700 | [diff] [blame] | 157 | # Note: These must use the "docs" prefix for links and image references. In |
| 158 | # contrast, the pw_doc_group above should not use the docs prefix. |
Alexei Frolov | 216808f | 2020-09-08 14:01:45 -0700 | [diff] [blame] | 159 | "build_system.rst", |
| 160 | "index.rst", |
| 161 | "module_guides.rst", |
Wyatt Hepler | b3ea980 | 2021-02-23 09:46:09 -0800 | [diff] [blame] | 162 | "python_build.rst", |
Alexei Frolov | 216808f | 2020-09-08 14:01:45 -0700 | [diff] [blame] | 163 | "targets.rst", |
| 164 | ] |
| 165 | output_directory = target_gen_dir |
| 166 | deps = [ |
| 167 | ":core_docs", |
| 168 | ":module_docs", |
| 169 | ":target_docs", |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 170 | "$dir_pw_env_setup:python.install", |
Alexei Frolov | 216808f | 2020-09-08 14:01:45 -0700 | [diff] [blame] | 171 | ] |
| 172 | } |