fix: generate doc case (#133)

Co-authored-by: rhyd42 <rhydian.roberts@chinasearch.co.uk>
sensiolabs · Jan 7, 2025 · 884eb43 · 884eb43
1 parent ee33766
commit 884eb43
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 13 deletions.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -31,7 +31,7 @@ jobs:
 
       - name: 'Check documentation'
         run: |
-          DIFF=$(git diff --name-only)
+          DIFF=$(git status --short --renames)
           if [[ $DIFF != '' ]]; then
             echo "::warning::Builders API documentation is not up to date. Please run \"php ./docs/generate.php\""
             echo "::warning::$DIFF"

diff --git a/docs/builders_api.md b/docs/builders_api.md
@@ -2,16 +2,16 @@
 
 ## Pdf
 
-* [HtmlPdfBuilder](./Pdf/builders_api/HtmlPdfBuilder.md)
-* [UrlPdfBuilder](./Pdf/builders_api/UrlPdfBuilder.md)
-* [MarkdownPdfBuilder](./Pdf/builders_api/MarkdownPdfBuilder.md)
-* [LibreOfficePdfBuilder](./Pdf/builders_api/LibreOfficePdfBuilder.md)
-* [MergePdfBuilder](./Pdf/builders_api/MergePdfBuilder.md)
-* [ConvertPdfBuilder](./Pdf/builders_api/ConvertPdfBuilder.md)
+* [HtmlPdfBuilder](./pdf/builders_api/HtmlPdfBuilder.md)
+* [UrlPdfBuilder](./pdf/builders_api/UrlPdfBuilder.md)
+* [MarkdownPdfBuilder](./pdf/builders_api/MarkdownPdfBuilder.md)
+* [LibreOfficePdfBuilder](./pdf/builders_api/LibreOfficePdfBuilder.md)
+* [MergePdfBuilder](./pdf/builders_api/MergePdfBuilder.md)
+* [ConvertPdfBuilder](./pdf/builders_api/ConvertPdfBuilder.md)
 
 ## Screenshot
 
-* [HtmlScreenshotBuilder](./Screenshot/builders_api/HtmlScreenshotBuilder.md)
-* [UrlScreenshotBuilder](./Screenshot/builders_api/UrlScreenshotBuilder.md)
-* [MarkdownScreenshotBuilder](./Screenshot/builders_api/MarkdownScreenshotBuilder.md)
+* [HtmlScreenshotBuilder](./screenshot/builders_api/HtmlScreenshotBuilder.md)
+* [UrlScreenshotBuilder](./screenshot/builders_api/UrlScreenshotBuilder.md)
+* [MarkdownScreenshotBuilder](./screenshot/builders_api/MarkdownScreenshotBuilder.md)
 
diff --git a/docs/generate.php b/docs/generate.php
@@ -20,15 +20,15 @@
  * @var array<string, non-empty-list<class-string>>
  */
 const BUILDERS = [
-    'Pdf' => [
+    'pdf' => [
         HtmlPdfBuilder::class,
         UrlPdfBuilder::class,
         MarkdownPdfBuilder::class,
         LibreOfficePdfBuilder::class,
         MergePdfBuilder::class,
         ConvertPdfBuilder::class,
     ],
-    'Screenshot' => [
+    'screenshot' => [
         HtmlScreenshotBuilder::class,
         UrlScreenshotBuilder::class,
         MarkdownScreenshotBuilder::class,
@@ -147,7 +147,7 @@ function saveFile(InputInterface $input, string $filename, string $contents): vo
                 throw new RuntimeException(\sprintf('Directory "%s" was not created', $directory));
             }
 
-            $summary .= "## {$type}\n\n";
+            $summary .= '## '.ucfirst($type)."\n\n";
 
             foreach ($builderClasses as $pdfBuilder) {
                 $reflectionClass = new ReflectionClass($pdfBuilder);

diff --git a/docs/pdf/builders_api/HtmlPdfBuilder.md b/docs/pdf/builders_api/HtmlPdfBuilder.md
@@ -50,6 +50,9 @@ Overrides the default margins (e.g., 0.39), in inches.
 * `preferCssPageSize(bool $bool)`:
 Define whether to prefer page size as defined by CSS. (Default false).
 
+* `generateDocumentOutline(bool $bool)`:
+Define whether the document outline should be embedded into the PDF. (Default false).
+
 * `printBackground(bool $bool)`:
 Prints the background graphics. (Default false).
 

diff --git a/docs/pdf/builders_api/MarkdownPdfBuilder.md b/docs/pdf/builders_api/MarkdownPdfBuilder.md
@@ -53,6 +53,9 @@ Overrides the default margins (e.g., 0.39), in inches.
 * `preferCssPageSize(bool $bool)`:
 Define whether to prefer page size as defined by CSS. (Default false).
 
+* `generateDocumentOutline(bool $bool)`:
+Define whether the document outline should be embedded into the PDF. (Default false).
+
 * `printBackground(bool $bool)`:
 Prints the background graphics. (Default false).
 

diff --git a/docs/pdf/builders_api/UrlPdfBuilder.md b/docs/pdf/builders_api/UrlPdfBuilder.md
@@ -52,6 +52,9 @@ Overrides the default margins (e.g., 0.39), in inches.
 * `preferCssPageSize(bool $bool)`:
 Define whether to prefer page size as defined by CSS. (Default false).
 
+* `generateDocumentOutline(bool $bool)`:
+Define whether the document outline should be embedded into the PDF. (Default false).
+
 * `printBackground(bool $bool)`:
 Prints the background graphics. (Default false).