Merge pull request #1218 from phpDocumentor/task/orphans

[BUGFIX] Ignore orphans in toctrees with globbing

Author: jaapio

packages/guides/src/Compiler/NodeTransformers/DocumentEntryRegistrationTransformer.php

@@ -66,6 +66,7 @@ public function leaveNode(Node $node, CompilerContextInterface $compilerContext)
             $node->getTitle() ?? TitleNode::emptyNode(),
             $node->isRoot(),
             $additionalData,
+            $node->isOrphan(),
         );
         $compilerContext->getProjectNode()->addDocumentEntry($entry);
 

packages/guides/src/Compiler/NodeTransformers/MenuNodeTransformers/GlobMenuEntryNodeTransformer.php

@@ -49,6 +49,10 @@ protected function handleMenuEntry(MenuNode $currentMenu, MenuEntryNode $entryNo
         $globExclude = explode(',', $currentMenu->getOption('globExclude') . '');
         $menuEntries = [];
         foreach ($documentEntries as $documentEntry) {
+            if ($documentEntry->isOrphan()) {
+                continue;
+            }
+
             if (
                 !self::matches($documentEntry->getFile(), $entryNode, $currentPath, $globExclude)
             ) {

packages/guides/src/Nodes/DocumentTree/DocumentEntryNode.php

@@ -34,6 +34,7 @@ public function __construct(
         private readonly TitleNode $titleNode,
         private readonly bool $isRoot = false,
         private array $additionalData = [],
+        private bool $orphan = false,
     ) {
     }
 
@@ -109,6 +110,11 @@ public function getAdditionalData(string $key): Node|null
         return $this->additionalData[$key] ?? null;
     }
 
+    public function isOrphan(): bool
+    {
+        return $this->orphan;
+    }
+
     public function addAdditionalData(string $key, Node $value): void
     {
         $this->additionalData[$key] = $value;

tests/Integration/tests-full/automatic_menu/automatic-default-menu/input/doNotInclude.rst

@@ -0,0 +1,6 @@
+:orphan:
+
+Do not Include in menu
+======================
+
+This is an orphan an must be ignored by glob patterns

tests/Integration/tests/toctree/toctree-glob-level-1/input/doNotInclude.rst

@@ -0,0 +1,6 @@
+:orphan:
+
+Do not Include in menu
+======================
+
+This is an orphan an must be ignored by glob patterns