Skip to content

Commit

Permalink
[TASK] Update phpdocumentor/guides (#139)
Browse files Browse the repository at this point in the history
Setting Iterator on a context became mandatory
Update all integration test templates due to
phpDocumentor/guides#718
  • Loading branch information
linawolf authored Nov 25, 2023
1 parent e0d843f commit 50bde22
Show file tree
Hide file tree
Showing 36 changed files with 193 additions and 177 deletions.
40 changes: 20 additions & 20 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function render(RenderCommand $renderCommand): void
$renderCommand->getDestination(),
$renderCommand->getDestinationPath(),
'singlepage',
);
)->withIterator($renderCommand->getDocumentIterator());

$context->getDestination()->put(
$renderCommand->getDestinationPath() . '/singlehtml/Index.html',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@
<div class="section" id="root-index">
<h1>Root index</h1>

<p>Lorem Ipsum Dolor. See <a href="sub/index.html#sub-index">Sub index</a>
.</p>
<p>Lorem Ipsum Dolor. See <a href="sub/index.html#sub-index">Sub index</a>.</p>
<div class="toctree-wrapper compound">
<ul class="menu-level">
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,7 @@
<div class="section" id="sub-index">
<h1>Sub index</h1>

<p>Lorem Ipsum Dolor. See <a href="../index.html#root-index">Root index</a>
.</p>
<p>Lorem Ipsum Dolor. See <a href="../index.html#root-index">Root index</a>.</p>
</div>

<!-- content end -->
Expand Down
12 changes: 6 additions & 6 deletions tests/Integration/tests/bignum/bignum-lists/expected/index.html
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- content start -->
<div class="section" id="styled-numbered-sections-bignums">
<div class="section" id="styled-numbered-sections-bignums">
<h1>Styled numbered sections (bignums)</h1>

<p>Lorem Ipsum Dolor.</p>
<div class="section" id="with-xxl-big-numbers">
<h2>With XXL Big Numbers</h2>



<ol class="bignums-xxl">
<li><p>ONE One one bignums-xxl</p><p>Lots of stories here ...</p></li>

Expand All @@ -32,8 +32,8 @@ <h2>With XXL Big Numbers</h2>
<div class="section" id="with-big-numbers-tip">
<h2>With Big Numbers - Tip</h2>



<ol class="bignums-tip">
<li><p>ONE One one bignums-tip</p><p>More ...</p></li>

Expand All @@ -47,4 +47,4 @@ <h2>With Big Numbers - Tip</h2>

</div>

<!-- content end -->
<!-- content end -->
12 changes: 6 additions & 6 deletions tests/Integration/tests/bignum/bignum-nested/expected/index.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<!-- content start -->
<div class="section" id="nested-bignums-xxl-bignums-normally-styled">
<div class="section" id="nested-bignums-xxl-bignums-normally-styled">
<h1>Nested bignums-xxl &gt; bignums &gt; Normally Styled</h1>



<ol class="bignums-xxl">
<li><p>ONE One one bignums-xxl</p><p>This is the story of my life ...</p>

<ol class="bignums">
<li><p>When I was young</p>

<ol>
<li>this</li>

Expand All @@ -31,4 +31,4 @@ <h1>Nested bignums-xxl &gt; bignums &gt; Normally Styled</h1>

</div>

<!-- content end -->
<!-- content end -->
8 changes: 4 additions & 4 deletions tests/Integration/tests/bootstrap-cards/expected/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- content start -->
<div class="section" id="simple-cards">
<div class="section" id="simple-cards">
<h1>Simple cards</h1>

<div class="row m-0 p-0">
Expand Down Expand Up @@ -44,7 +44,7 @@ <h2>Cards with buttons in the footer</h2>
<p>The Page Management Guide introduces TYPO3&#039;s Page Tree and explains how pages are created and managed.</p>
</div>
<div class="card-footer pb-0">


<ul class="horizbuttons-striking-m">
<li><a href="https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/Pages/Index.html">12-dev</a></li>
Expand All @@ -68,7 +68,7 @@ <h2>Cards with buttons in the footer</h2>
<p>The Content Creation Guide shows how page content is created in the form of Content Elements.</p>
</div>
<div class="card-footer pb-0">


<ul class="horizbuttons-striking-m">
<li><a href="https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/ContentElements/Index.html">12-dev</a></li>
Expand All @@ -91,4 +91,4 @@ <h2>Cards with buttons in the footer</h2>

</div>

<!-- content end -->
<!-- content end -->
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<!-- content start -->
<div class="section" id="just-a-code-block">
<div class="section" id="just-a-code-block">
<h1>Just a code block</h1>
<div translate="no">

<div translate="no">

<pre><code>echo &#039;Hello, TYPO3&#039;;</code></pre>
</div>
</div>
<!-- content end -->
</div>

<!-- content end -->
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
<!-- content start -->
<div class="section" id="with-caption">
<div class="section" id="with-caption">
<h1>With caption</h1>
<div class="code-block-caption">
<span class="caption-text">src/hello.php</span>
</div><div translate="no">

<div class="code-block-caption">
<span class="caption-text">src/hello.php</span>
</div><div translate="no">

<pre><code class="hljs php"><span class="hljs-keyword">echo</span> <span class="hljs-string">'Hello, TYPO3'</span>;</code></pre>
</div>
</div>
<!-- content end -->
</div>

<!-- content end -->
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
<!-- content start -->
<div class="section" id="with-classes">
<div class="section" id="with-classes">
<h1>With classes</h1>
<div translate="no">

<div translate="no">

<pre class="some-class another-class"><code class="hljs python"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">some_function</span><span class="hljs-params">()</span>:</span>
interesting = <span class="hljs-literal">False</span></code></pre>
interesting = <span class="hljs-literal">False</span></code></pre>
</div>
</div>
<!-- content end -->
</div>

<!-- content end -->
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
<!-- content start -->
<div class="section" id="with-emphasize-lines">
<div class="section" id="with-emphasize-lines">
<h1>With emphasize lines</h1>
<div translate="no">

<div translate="no">

<pre><code class="hljs python"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">some_function</span><span class="hljs-params">()</span>:</span>
interesting = <span class="hljs-literal">False</span>
interesting = <span class="hljs-literal">False</span>
<span data-emphasize-line> print(<span class="hljs-string">'This line is highlighted.'</span>)</span>
print(<span class="hljs-string">'This one is not...'</span>)
print(<span class="hljs-string">'This one is not...'</span>)
<span data-emphasize-line> print(<span class="hljs-string">'...but this one is.'</span>)</span></code></pre>
</div>
</div>
<!-- content end -->
</div>

<!-- content end -->
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<!-- content start -->
<div class="section" id="with-language">
<div class="section" id="with-language">
<h1>With language</h1>
<div translate="no">

<div translate="no">

<pre><code class="hljs php"><span class="hljs-keyword">echo</span> <span class="hljs-string">'Hello, TYPO3'</span>;</code></pre>
</div>
</div>
<!-- content end -->
</div>

<!-- content end -->
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<!-- content start -->
<div class="section" id="with-line-numbers">
<div class="section" id="with-line-numbers">
<h1>With line numbers</h1>
<div translate="no">

<div translate="no">

<pre><code class="hljs ruby"><span data-line-number="10">Some more Ruby code.</span></code></pre>
</div>
</div>
<!-- content end -->
</div>

<!-- content end -->
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<!-- content start -->
<div class="section" id="with-line-number-start">
<div class="section" id="with-line-number-start">
<h1>With line number start</h1>
<div translate="no">

<div translate="no">

<pre><code class="hljs ruby"><span data-line-number="1">Some more Ruby code, with line numbering starting at <span class="hljs-number">10</span>.</span></code></pre>
</div>
</div>
<!-- content end -->
</div>

<!-- content end -->
15 changes: 7 additions & 8 deletions tests/Integration/tests/configuration/expected/index.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
<!-- content start -->
<div class="section" id="document-title">
<div class="section" id="document-title">
<h1>Document Title</h1>

<p>Learn more about how to <a href="https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Index.html#start">write documentation</a>
or have
a look at <a href="https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/Index.html#start">TYPO3 Explained</a>
.</p>
<p>Learn more about how to <a href="https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Index.html#start">write documentation</a> or have
a look at <a href="https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/Index.html#start">TYPO3 Explained</a>.</p>
<p>Here is some PHP code:</p>
<div translate="no">
<pre><code class="hljs php">$lorem = <span class="hljs-string">"ipsum dolor\n"</span>;</code></pre>
</div>

<pre><code class="hljs php">$lorem = <span class="hljs-string">"ipsum dolor\n"</span>;</code></pre>
</div>
</div>

<!-- content end -->
<!-- content end -->
Loading

0 comments on commit 50bde22

Please sign in to comment.