mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-21 14:16:26 +00:00
baaa2d62a6
This change adds a module which builds documentation using Sphinx. Documentation files and assets are defined using a pw_doc_group GN template which lists out all of the sources as metadata. Another GN template, pw_doc_gen, collects the metadata from pw_doc_group targets into a JSON file and defines an action that runs a script to build the HTML docs. A docgen script is provided by the pw_docgen module. This script reads the JSON metadata file collected by a pw_doc_gen template, copies all of the source and resource files into a documentation tree, and runs Sphinx on the tree to render the docs as HTML. Change-Id: I97890f05d850d5119cbd3bbf48138cd82f22d56c
32 lines
1.3 KiB
Plaintext
32 lines
1.3 KiB
Plaintext
# Copyright 2019 The Pigweed Authors
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
# use this file except in compliance with the License. You may obtain a copy of
|
|
# the License at
|
|
#
|
|
# https://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations under
|
|
# the License.
|
|
|
|
# This file defines a directory variable for each of Pigweed's modules. This
|
|
# allows modules to be moved or swapped out without breaking existing builds.
|
|
# All module variables are prefixed with dir_.
|
|
|
|
declare_args() {
|
|
# Location of the Pigweed modules directory (defaults to the directory of
|
|
# this file).
|
|
dir_pigweed = get_path_info(get_path_info("BUILD.gn", "abspath"), "dir")
|
|
}
|
|
|
|
dir_pw_build = "$dir_pigweed/pw_build"
|
|
dir_pw_docgen = "$dir_pigweed/pw_docgen"
|
|
dir_pw_preprocessor = "$dir_pigweed/pw_preprocessor"
|
|
dir_pw_span = "$dir_pigweed/pw_span"
|
|
dir_pw_status = "$dir_pigweed/pw_status"
|
|
dir_pw_toolchain = "$dir_pigweed/pw_toolchain"
|
|
dir_pw_unit_test = "$dir_pigweed/pw_unit_test"
|