build stdlib docs with docc

Author: QuietMisdreavus

utils/swift_build_support/swift_build_support/build_script_invocation.py

@@ -710,6 +710,8 @@ def compute_product_pipelines(self):
         )
         builder.add_product(products.SwiftDocCRender,
                             is_enabled=install_doccrender)
+        builder.add_product(products.StdlibDocs,
+                            is_enabled=self.args.build_stdlib_docs)
 
         # Keep SwiftDriver at last.
         # swift-driver's integration with the build scripts is not fully

utils/swift_build_support/swift_build_support/products/__init__.py

@@ -29,6 +29,7 @@
 from .skstresstester import SKStressTester
 from .sourcekitlsp import SourceKitLSP
 from .staticswiftlinux import StaticSwiftLinuxConfig
+from .stdlib_docs import StdlibDocs
 from .swift import Swift
 from .swift_testing import SwiftTesting
 from .swift_testing_macros import SwiftTestingMacros
@@ -65,6 +66,7 @@
     'Ninja',
     'PlaygroundSupport',
     'StaticSwiftLinuxConfig',
+    'StdlibDocs',
     'Swift',
     'SwiftFormat',
     'SwiftInspect',

utils/swift_build_support/swift_build_support/products/stdlib_docs.py

@@ -0,0 +1,77 @@
+# swift_build_support/products/stdlib_docs.py -------------------*- python -*-
+#
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
+# Licensed under Apache License v2.0 with Runtime Library Exception
+#
+# See https://swift.org/LICENSE.txt for license information
+# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+#
+# ----------------------------------------------------------------------------
+
+import os
+
+from . import product
+from . import swiftdocc
+from . import swiftdoccrender
+from .. import shell
+
+
+class StdlibDocs(product.Product):
+    @classmethod
+    def is_build_script_impl_product(cls):
+        return False
+
+    @classmethod
+    def is_before_build_script_impl_product(cls):
+        return False
+
+    @classmethod
+    def is_swiftpm_unified_build_product(cls):
+        return False
+
+    def should_build(self, host_target):
+        return self.args.build_stdlib_docs
+
+    def build(self, host_target):
+        toolchain_path = self.install_toolchain_path(host_target)
+        docc_path = os.path.join(toolchain_path, "bin", "docc")
+
+        swift_build_dir = os.path.join(
+            os.path.dirname(self.build_dir),
+            f'swift-{host_target}'
+        )
+        symbol_graph_dir = os.path.join(swift_build_dir, "lib", "symbol-graph")
+        output_path = os.path.join(swift_build_dir, "Swift.doccarchive")
+
+        docc_cmd = [
+            docc_path,
+            "convert",  # TODO: give people the option to preview instead
+            "--additional-symbol-graph-dir",
+            symbol_graph_dir,
+            "--output-path",
+            output_path,
+            "--default-code-listing-language",
+            "swift",
+            "--fallback-display-name",
+            "Swift",
+            "--fallback-bundle-identifier",
+            "org.swift.swift",
+        ]
+
+        shell.call(docc_cmd)
+
+    def should_test(self, host_target):
+        return False
+
+    def should_install(self, host_target):
+        return False
+
+    @classmethod
+    def get_dependencies(cls):
+        """Return a list of products that this product depends upon"""
+        return [
+            swiftdocc.SwiftDocC,
+            swiftdoccrender.SwiftDocCRender
+        ]