blob: aff6fa1f2728d60751947cac7717dd26165bd005 [file] [log] [blame]
Alexei Frolov0efdb112019-11-14 17:22:08 -08001# 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
15import("$dir_pw_docgen/docs.gni")
16
Keir Mierle2c1e56b2019-11-15 16:32:11 -080017pw_doc_group("core_docs") {
18 sources = [
19 "embedded_cpp_guide.rst",
20 "style_guide.rst",
21 ]
22}
23
Armando Montanez08745582019-12-12 10:51:50 -080024# Documentation for upstream Pigweed targets.
25group("target_docs") {
Rob Mohra0ba54f2020-02-27 11:43:49 -080026 deps = [ "$dir_pigweed/targets/stm32f429i-disc1:target_docs" ]
Armando Montanez08745582019-12-12 10:51:50 -080027}
28
Alexei Frolov0efdb112019-11-14 17:22:08 -080029pw_doc_gen("docs") {
30 conf = "conf.py"
Wyatt Heplerb82f9952019-11-25 13:56:31 -080031 sources = [
Armando Montanez42225322020-01-02 13:11:41 -080032 "../README.md",
Wyatt Heplerb82f9952019-11-25 13:56:31 -080033 "index.rst",
34 "modules.rst",
Armando Montanez08745582019-12-12 10:51:50 -080035 "targets.rst",
Wyatt Heplerb82f9952019-11-25 13:56:31 -080036 ]
Alexei Frolov0efdb112019-11-14 17:22:08 -080037 output_directory = target_gen_dir
38 deps = [
Keir Mierle2c1e56b2019-11-15 16:32:11 -080039 ":core_docs",
Armando Montanez08745582019-12-12 10:51:50 -080040 ":target_docs",
Keir Mierle3cee8792020-01-22 17:08:13 -080041 "$dir_pw_assert:docs",
Keir Mierleec9bf1b2020-03-03 10:27:01 -080042 "$dir_pw_assert_basic:docs",
Alexei Frolov0efdb112019-11-14 17:22:08 -080043 "$dir_pw_bloat:docs",
Armando Montanez70095662020-01-09 14:25:04 -080044 "$dir_pw_boot_armv7m:docs",
Rob Mohr49de4922019-12-10 20:10:41 -080045 "$dir_pw_build:docs",
Armando Montanez5104cd62019-12-10 14:36:43 -080046 "$dir_pw_cpu_exception:docs",
47 "$dir_pw_cpu_exception_armv7m:docs",
Alexei Frolov8ffcb912019-11-18 11:00:20 -080048 "$dir_pw_docgen:docs",
Rob Mohrf82e7a82020-01-03 13:50:11 -080049 "$dir_pw_doctor:docs",
Rob Mohrd45e2342020-03-03 15:02:18 -080050 "$dir_pw_env_setup:docs",
Keir Mierleaf5e3582019-12-30 13:11:05 -080051 "$dir_pw_log:docs",
Wyatt Hepler0412a7d2020-01-28 16:27:32 -080052 "$dir_pw_minimal_cpp_stdlib:docs",
Keir Mierlec34f71f2019-12-06 12:44:47 -080053 "$dir_pw_module:docs",
Wyatt Heplerc542a5d2020-01-15 15:43:10 -080054 "$dir_pw_polyfill:docs",
Alexei Frolov0efdb112019-11-14 17:22:08 -080055 "$dir_pw_preprocessor:docs",
Wyatt Hepleree3e02f2019-12-05 10:52:31 -080056 "$dir_pw_presubmit:docs",
Alexei Frolov9c2ed462020-01-13 15:35:42 -080057 "$dir_pw_protobuf:docs",
Alexei Frolov942adf02019-12-11 17:07:28 -080058 "$dir_pw_protobuf_compiler:docs",
Wyatt Hepleree3e02f2019-12-05 10:52:31 -080059 "$dir_pw_span:docs",
60 "$dir_pw_status:docs",
Wyatt Heplerfe85de22019-11-19 17:10:20 -080061 "$dir_pw_string:docs",
Armando Montanezf7a5a742020-03-02 14:58:59 -080062 "$dir_pw_sys_io:docs",
63 "$dir_pw_sys_io_baremetal_stm32f429:docs",
64 "$dir_pw_sys_io_stdio:docs",
Alexei Frolov300dcea2019-12-23 13:33:59 -080065 "$dir_pw_target_runner:docs",
Wyatt Hepler80c6ee52020-01-03 09:54:58 -080066 "$dir_pw_tokenizer:docs",
Alexei Frolov0efdb112019-11-14 17:22:08 -080067 ]
68}