Fix issue on versionadded by modifying its dom

nikophil · nikophil · commit 474fcbeca4f2 · 2018-10-09T17:56:42.000+02:00
diff --git a/_build/notes.md b/_build/notes.md
@@ -6,6 +6,7 @@ Changes needed in symfony.com
 - idem for `sidebar` (the `.first` css class is not even used in css)
 - `div.section` are now removed, so the `margin-top` needd to go on `<hX>`
 - `<p>` added to `.. seealso::` directive 
+- `versionadded` dom changed 
 
 Notes
 =====
diff --git a/_build/src/Directive/VersionAddedDirective.php b/_build/src/Directive/VersionAddedDirective.php
@@ -3,7 +3,7 @@
 namespace SymfonyDocs\Directive;
 
 use Doctrine\RST\Nodes\Node;
-use Doctrine\RST\Nodes\RawNode;
+use Doctrine\RST\Nodes\WrapperNode;
 use Doctrine\RST\Parser;
 use Doctrine\RST\SubDirective;
 
@@ -24,6 +24,10 @@ public function processSub(
         string $data,
         array $options
     ): ?Node {
-        return new RawNode(sprintf('<div class="versionadded"><p><span class="versionmodified">New in version %s: </span>%s</p></div>', $data, trim(strip_tags((string) $document, '<a><code>'))));
+        return new WrapperNode(
+            $document,
+            sprintf('<div class="versionadded"><div><span class="versionmodified">New in version %s: </span>', $data),
+            '</div></div>'
+        );
     }
 }
diff --git a/_build/src/JsonGenerator.php b/_build/src/JsonGenerator.php
@@ -90,8 +90,12 @@ private function getMeta(string $parserFilename): MetaEntry
         return $allMetas[$parserFilename];
     }
 
-    private function generateToc(MetaEntry $metaEntry, array $titles): array
+    private function generateToc(MetaEntry $metaEntry, ?array $titles): array
     {
+        if (null === $titles) {
+            return [];
+        }
+
         $tocTree = [];
 
         foreach ($titles as $title) {
diff --git a/_build/tests/fixtures/expected/blocks/versionadded.html b/_build/tests/fixtures/expected/blocks/versionadded.html
@@ -5,7 +5,10 @@
 </head>
 <body>
 <div class="versionadded">
-    <p><span class="versionmodified">New in version 4.1: </span>This option was introduced in Symfony 2.6 and replaces another option, which is available prior to 2.6.</p>
+    <div>
+        <span class="versionmodified">New in version 4.1: </span>
+        <p>This option was introduced in Symfony 2.6 and replaces another option, which is available prior to 2.6.</p>
+    </div>
 </div>
 </body>
 </html>
diff --git a/_build/tests/fixtures/expected/doc-reference/index.html b/_build/tests/fixtures/expected/doc-reference/index.html
@@ -4,6 +4,7 @@
     <meta charset="utf-8" />
 </head>
 <body>
+<h1 id="a-test-for-doc-link">A test for doc link<a class="headerlink" href="#a-test-for-doc-link" title="Permalink to this headline">¶</a></h1>
 <p><a href="file.html" class="reference internal"><em>A doc test</em></a></p>
 </body>
 </html>
diff --git a/_build/tests/fixtures/expected/main/datetime.html b/_build/tests/fixtures/expected/main/datetime.html
@@ -91,8 +91,9 @@ <h3 id="date-widget">date_widget<a class="headerlink" href="#date-widget" title=
 
 <h3 id="placeholder">placeholder<a class="headerlink" href="#placeholder" title="Permalink to this headline">¶</a></h3>
 <div class="versionadded">
-    <p><span class="versionmodified">New in version 2.6: </span>The <code class="notranslate">placeholder</code> option was introduced in Symfony 2.6 and replaces
-<code class="notranslate">empty_value</code>, which is available prior to 2.6.</p>
+    <div><span class="versionmodified">New in version 2.6: </span><p>The <code class="notranslate">placeholder</code> option was introduced in Symfony 2.6 and replaces
+<code class="notranslate">empty_value</code>, which is available prior to 2.6.
+<a href="form/form_type.html#internal-reference" class="reference internal"><span>FormType Documentation</span></a></p></div>
 </div>
 
 <p><strong>type</strong>: <code class="notranslate">string</code> | <code class="notranslate">array</code></p>
diff --git a/_build/tests/fixtures/expected/ref-reference/index.html b/_build/tests/fixtures/expected/ref-reference/index.html
@@ -4,6 +4,7 @@
     <meta charset="utf-8" />
 </head>
 <body>
+<h1 id="a-test-for-reference">A test for reference<a class="headerlink" href="#a-test-for-reference" title="Permalink to this headline">¶</a></h1>
 <p><a href="file.html#ref-test" class="reference internal"><span>A ref test</span></a></p>
 </body>
 </html>
diff --git a/_build/tests/fixtures/source/doc-reference/index.rst b/_build/tests/fixtures/source/doc-reference/index.rst
@@ -1,3 +1,5 @@
+A test for doc link
+===================
 
 :doc:`A doc test </file>`
 
diff --git a/_build/tests/fixtures/source/ref-reference/index.rst b/_build/tests/fixtures/source/ref-reference/index.rst
@@ -1,3 +1,5 @@
+A test for reference
+====================
 
 :ref:`A ref test <ref-test>`
 

Original file line number	Diff line number	Diff line change
`@@ -90,8 +90,12 @@ private function getMeta(string $parserFilename): MetaEntry`
`90`	`90`	`return $allMetas[$parserFilename];`
`91`	`91`	`}`
`92`	`92`
`93`		`- private function generateToc(MetaEntry $metaEntry, array $titles): array`
	`93`	`+ private function generateToc(MetaEntry $metaEntry, ?array $titles): array`
`94`	`94`	`{`
	`95`	`+ if (null === $titles) {`
	`96`	`+ return [];`
	`97`	`+ }`
	`98`	`+`
`95`	`99`	`$tocTree = [];`
`96`	`100`
`97`	`101`	`foreach ($titles as $title) {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+A test for doc link`
	`2`	`+===================`
`1`	`3`
`2`	`4`	:doc:`A doc test </file>`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+A test for reference`
	`2`	`+====================`
`1`	`3`
`2`	`4`	:ref:`A ref test <ref-test>`
`3`	`5`