From fc6e13155fc653f62b01b1e3e85ba5dbb515e843 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Fri, 12 Apr 2024 21:05:50 +0200 Subject: [PATCH] docs: exclude summary page from search (#1035) ### Summary of Changes The summary page is only needed for navigation. It should never be accessed directly. This PR excludes the page from the search. --- docs/stdlib/SUMMARY.md | 5 +++++ .../src/language/generation/safe-ds-markdown-generator.ts | 4 +++- .../markdown/annotations/deprecated/generated/SUMMARY.md | 5 +++++ .../markdown/annotations/documented/generated/SUMMARY.md | 5 +++++ .../markdown/annotations/experimental/generated/SUMMARY.md | 5 +++++ .../markdown/annotations/undocumented/generated/SUMMARY.md | 5 +++++ .../markdown/classes/deprecated/generated/SUMMARY.md | 5 +++++ .../markdown/classes/documented/generated/SUMMARY.md | 5 +++++ .../markdown/classes/experimental/generated/SUMMARY.md | 5 +++++ .../markdown/classes/undocumented/generated/SUMMARY.md | 5 +++++ .../generation/markdown/deprecated/generated/SUMMARY.md | 5 +++++ .../markdown/enums/deprecated/generated/SUMMARY.md | 5 +++++ .../markdown/enums/documented/generated/SUMMARY.md | 5 +++++ .../markdown/enums/experimental/generated/SUMMARY.md | 5 +++++ .../markdown/enums/undocumented/generated/SUMMARY.md | 5 +++++ .../markdown/functions/deprecated/generated/SUMMARY.md | 5 +++++ .../markdown/functions/documented/generated/SUMMARY.md | 5 +++++ .../markdown/functions/experimental/generated/SUMMARY.md | 5 +++++ .../markdown/functions/undocumented/generated/SUMMARY.md | 5 +++++ .../generation/markdown/link tag/generated/SUMMARY.md | 5 +++++ .../generation/markdown/multiline/generated/SUMMARY.md | 5 +++++ .../generation/markdown/pipelines/generated/SUMMARY.md | 5 +++++ .../markdown/schemas/deprecated/generated/SUMMARY.md | 5 +++++ .../markdown/schemas/documented/generated/SUMMARY.md | 5 +++++ .../markdown/schemas/experimental/generated/SUMMARY.md | 5 +++++ .../markdown/schemas/undocumented/generated/SUMMARY.md | 5 +++++ .../markdown/segments/deprecated/generated/SUMMARY.md | 5 +++++ .../markdown/segments/documented/generated/SUMMARY.md | 5 +++++ .../markdown/segments/experimental/generated/SUMMARY.md | 5 +++++ .../markdown/segments/undocumented/generated/SUMMARY.md | 5 +++++ .../generation/markdown/summary/generated/SUMMARY.md | 5 +++++ 31 files changed, 153 insertions(+), 1 deletion(-) diff --git a/docs/stdlib/SUMMARY.md b/docs/stdlib/SUMMARY.md index d3efcdd3a..7e74858da 100644 --- a/docs/stdlib/SUMMARY.md +++ b/docs/stdlib/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - safeds - data - image diff --git a/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts b/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts index faa08ed85..e86896818 100644 --- a/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts +++ b/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts @@ -544,7 +544,9 @@ export class SafeDsMarkdownGenerator { options.destination, details.map((document) => URI.parse(document.uri)), ); - const content = this.describeSummary('', summary); + + const frontMatter = `---\nsearch:\n exclude: true\n---\n\n`; + const content = frontMatter + this.describeSummary('', summary); return TextDocument.create(uri, 'md', 0, content); } diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/deprecated/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/deprecated/generated/SUMMARY.md index bcaa5397c..3f6869e8a 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/deprecated/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/deprecated/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/documented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/documented/generated/SUMMARY.md index 9ac83ba17..7fd4a3d55 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/documented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/documented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/experimental/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/experimental/generated/SUMMARY.md index 72fd3740b..bdffc01c3 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/experimental/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/experimental/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/undocumented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/undocumented/generated/SUMMARY.md index 52b11cce3..1ece77421 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/undocumented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/annotations/undocumented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/classes/deprecated/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/classes/deprecated/generated/SUMMARY.md index 7ff094aca..a50a98ece 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/classes/deprecated/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/classes/deprecated/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/classes/documented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/classes/documented/generated/SUMMARY.md index fe38df52a..53647b338 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/classes/documented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/classes/documented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/classes/experimental/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/classes/experimental/generated/SUMMARY.md index 0d62eb709..9a968e314 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/classes/experimental/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/classes/experimental/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/classes/undocumented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/classes/undocumented/generated/SUMMARY.md index 8858df31b..4be9c96a3 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/classes/undocumented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/classes/undocumented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/deprecated/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/deprecated/generated/SUMMARY.md index 3152060fa..227dfbf85 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/deprecated/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/deprecated/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/enums/deprecated/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/enums/deprecated/generated/SUMMARY.md index d5ed30e70..5a26b9345 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/enums/deprecated/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/enums/deprecated/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/enums/documented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/enums/documented/generated/SUMMARY.md index e94e85a05..a990cec9e 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/enums/documented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/enums/documented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/enums/experimental/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/enums/experimental/generated/SUMMARY.md index 25595e5d7..09da47828 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/enums/experimental/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/enums/experimental/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/enums/undocumented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/enums/undocumented/generated/SUMMARY.md index dd6360a62..40c2acb75 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/enums/undocumented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/enums/undocumented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/functions/deprecated/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/functions/deprecated/generated/SUMMARY.md index e5486e156..53fae9a34 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/functions/deprecated/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/functions/deprecated/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/functions/documented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/functions/documented/generated/SUMMARY.md index f48d3ef03..9358b1a55 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/functions/documented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/functions/documented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/functions/experimental/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/functions/experimental/generated/SUMMARY.md index 799866f4b..318dec75a 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/functions/experimental/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/functions/experimental/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/functions/undocumented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/functions/undocumented/generated/SUMMARY.md index 9fe4b6007..7477926c0 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/functions/undocumented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/functions/undocumented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/link tag/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/link tag/generated/SUMMARY.md index b0735de32..977cea621 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/link tag/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/link tag/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/multiline/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/multiline/generated/SUMMARY.md index f4efa8aac..74d05342f 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/multiline/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/multiline/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/pipelines/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/pipelines/generated/SUMMARY.md index f585680b7..f75dfe6e8 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/pipelines/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/pipelines/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/deprecated/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/deprecated/generated/SUMMARY.md index 784f99466..c1f4982c9 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/deprecated/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/deprecated/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/documented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/documented/generated/SUMMARY.md index 115863e0c..0e4ff7c45 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/documented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/documented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/experimental/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/experimental/generated/SUMMARY.md index c45ad1a7a..9da8a683b 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/experimental/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/experimental/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/undocumented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/undocumented/generated/SUMMARY.md index 86305c0f1..17876533b 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/undocumented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/schemas/undocumented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/segments/deprecated/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/segments/deprecated/generated/SUMMARY.md index b5e0ef903..ddaf34afb 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/segments/deprecated/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/segments/deprecated/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/segments/documented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/segments/documented/generated/SUMMARY.md index 01e7655cc..37beed14a 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/segments/documented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/segments/documented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/segments/experimental/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/segments/experimental/generated/SUMMARY.md index 57ae508e2..c3fe9dace 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/segments/experimental/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/segments/experimental/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/segments/undocumented/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/segments/undocumented/generated/SUMMARY.md index 40a3080d2..26df957a3 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/segments/undocumented/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/segments/undocumented/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown diff --git a/packages/safe-ds-lang/tests/resources/generation/markdown/summary/generated/SUMMARY.md b/packages/safe-ds-lang/tests/resources/generation/markdown/summary/generated/SUMMARY.md index 449a3de27..8e315949d 100644 --- a/packages/safe-ds-lang/tests/resources/generation/markdown/summary/generated/SUMMARY.md +++ b/packages/safe-ds-lang/tests/resources/generation/markdown/summary/generated/SUMMARY.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + - tests - generation - markdown