skills/angular__angular
1
0
Fork 0
mirror of https://github.com/angular/angular.git synced 2026-09-14 13:54:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

build(docs-infra): include API references for @angular/ssr entry points (#58445)

Browse Source 
This commit utilizes the `@angular/ssr` NPM package to generate an API reference for its entry points using the `generate_api_docs` Bazel rule, which will be included in http://angular.dev/api.

PR Close #58445
This commit is contained in:
Alan Agius
2024-10-31 09:32:57 +00:00
committed by Jessica Janiuk
parent 9aff978fac
commit c11ef4fade
3 changed files with 72 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
adev/src/assets/BUILD.bazel
+3
View File
@@ -40,6 +40,9 @@ copy_to_directory(
"//adev/src/content/tutorials/deferrable-views:deferrable-views-guides",
"//adev/src/content/tutorials/first-app:first-app-guides",
"//adev/src/content/tutorials/learn-angular:learn-angular-guides",
"//packages:angular_ssr_docs",
"//packages:angular_ssr_node_docs",
"//packages:angular_ssr_tokens_docs",
"//packages/animations:animations_docs",
"//packages/animations/browser:animations_browser_docs",
"//packages/animations/browser/testing:animations_browser_testing_docs",
packages/BUILD.bazel
+35 -1
View File
@@ -1,4 +1,4 @@
load("//tools:defaults.bzl", "ts_config", "ts_library")
load("//tools:defaults.bzl", "generate_api_docs", "ts_config", "ts_library")
load("//:packages.bzl", "DOCS_ENTRYPOINTS")
load("//adev/shared-docs/pipeline/api-gen/manifest:generate_api_manifest.bzl", "generate_api_manifest")
@@ -70,6 +70,9 @@ filegroup(
generate_api_manifest(
name = "docs_api_manifest",
srcs = [
":angular_ssr_docs_extraction",
":angular_ssr_node_docs_extraction",
":angular_ssr_tokens_docs_extraction",
"//packages/animations:animations_docs_extraction",
"//packages/animations/browser:animations_browser_docs_extraction",
"//packages/animations/browser/testing:animations_browser_testing_docs_extraction",
@@ -106,3 +109,34 @@ generate_api_manifest(
"//tools/manual_api_docs/elements",
],
)
### @angular/ssr package located in the Angular/CLI repository
generate_api_docs(
name = "angular_ssr_docs",
srcs = [
":common_files_and_deps_for_docs",
"@npm//@angular/ssr",
],
entry_point = "@npm//:node_modules/@angular/ssr/index.d.ts",
module_name = "@angular/ssr",
)
generate_api_docs(
name = "angular_ssr_node_docs",
srcs = [
":common_files_and_deps_for_docs",
"@npm//@angular/ssr",
],
entry_point = "@npm//:node_modules/@angular/ssr/node/index.d.ts",
module_name = "@angular/ssr/node",
)
generate_api_docs(
name = "angular_ssr_tokens_docs",
srcs = [
":common_files_and_deps_for_docs",
"@npm//@angular/ssr",
],
entry_point = "@npm//:node_modules/@angular/ssr/tokens/index.d.ts",
module_name = "@angular/ssr/tokens",
)
packages/ssr/BUILD.bazel
+34
View File
@@ -0,0 +1,34 @@
load("//tools:defaults.bzl", "generate_api_docs")
package(default_visibility = ["//visibility:public"])
### @angular/ssr package located in the Angular/CLI repository
generate_api_docs(
name = "ssr_docs",
srcs = [
"//packages:common_files_and_deps_for_docs",
"@npm//@angular/ssr",
],
entry_point = "@npm//:node_modules/@angular/ssr/index.d.ts",
module_name = "@angular/ssr",
)
generate_api_docs(
name = "ssr_node_docs",
srcs = [
"//packages:common_files_and_deps_for_docs",
"@npm//@angular/ssr",
],
entry_point = "@npm//:node_modules/@angular/ssr/node/index.d.ts",
module_name = "@angular/ssr/node",
)
generate_api_docs(
name = "ssr_tokens_docs",
srcs = [
"//packages:common_files_and_deps_for_docs",
"@npm//@angular/ssr",
],
entry_point = "@npm//:node_modules/@angular/ssr/tokens/index.d.ts",
module_name = "@angular/ssr/tokens",
)